{"id":18823093,"url":"https://github.com/toad-lib/toad.dev-docs","last_synced_at":"2026-01-24T08:03:54.477Z","repository":{"id":41453597,"uuid":"509651056","full_name":"toad-lib/toad.dev-docs","owner":"toad-lib","description":"Documentation accessible from www.kwap.rs","archived":false,"fork":false,"pushed_at":"2022-10-08T16:07:50.000Z","size":140,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-12-30T04:19:44.329Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PureScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/toad-lib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-07-02T03:51:16.000Z","updated_at":"2022-07-28T23:30:23.000Z","dependencies_parsed_at":"2023-01-19T15:25:18.838Z","dependency_job_id":null,"html_url":"https://github.com/toad-lib/toad.dev-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toad-lib%2Ftoad.dev-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toad-lib%2Ftoad.dev-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toad-lib%2Ftoad.dev-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toad-lib%2Ftoad.dev-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/toad-lib","download_url":"https://codeload.github.com/toad-lib/toad.dev-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239758905,"owners_count":19692044,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T00:52:41.665Z","updated_at":"2026-01-19T08:30:14.342Z","avatar_url":"https://github.com/toad-lib.png","language":"PureScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# toad-docs\nStatic content served by www.kwap.rs\n\n# Structure\n`/book` contains the pages of \"the kwap book\" which is the multi-language\nliving documentation for kwap and its APIs.\n\n`/concepts` contains zettelkasten-style atomic notes that reference one another,\nthat may be viewed on their own or in the context of the book.\n\n## The book\nBook pages are markdown docs with names of the form:\n```\nbook/{n}-{title}{sub-page-title}.md\n\nn: 3-digit number that drives the ordering of the page\n   e.g. `001`, `002`, `123`\n\ntitle: hyphen-spaced title of the page\n       e.g. `coap-options`, `foo-bar`\n\nsub-page-title: title of a subpage prepended by ---\n                e.g. `---error-handling`, `---baz`\n```\n\ne.g.\n```text\nbook/001-CoAP-Options.md\nbook/001-CoAP-Options---If-Match.md\nbook/001-CoAP-Options---ETag.md\nbook/002-foo.md\nbook/002-foo---bar.md\nbook/002-foo---baz.md\nbook/002-foo---quux.md\n```\n\nwill be rendered as the hierarchy:\n\n- CoAP Options\n   - If-Match\n   - ETag\n- foo\n   - bar\n   - baz\n   - quux\n\n# Markdown\nThe Markdown parser in toad.dev-purs doesn't support tables.\n\nYou also need to introduce a leading space to lists, e.g.\n```md\n- i won't be\n- rendered properly\n\n - but i\n - will\n```\n\n## Link to Concepts\n```\n[option](@CoAP-Option)\n```\nwill be expanded to a link with the text \"option\" to `concepts/CoAP-Option.md`.\n\n## Code samples\ncode fences' language tag should be of this form:\n\n```\nkwap/{platform}^{package-version}\n\nplatform:\n  one of [rust, embedded-rust, android-kotlin, ios-swift, node-typescript, node-purescript, react-native]\n\npackage-version:\n  the major version number of the `kwap` package in that platform's ecosystem.\n```\n\nin this form, the code sample will only be rendered in `kwap-rs`\nwhen the user is viewing `kwap-rs` in that mode,\nand they will be run as automated tests.\n\ne.g. for the following markdown: (_ignore the spaces between the backticks, that's just to get it to render properly on github_)\n```\n` ` `rust\nfn main() {\n  println!(\"foot\");\n}\n` ` `\n` ` `kwap/javascript^1\nconsole.log(\"foo\");\n` ` `\n` ` `kwap/javascript^2\nimport Console from 'fancy-logging-lib';\nConsole.log(\"foo\");\n` ` `\n` ` `kwap/rust^1\nfn main() {\n  println!(\"foo\");\n}\n` ` `\n```\n\nAll users will see the first code sample, because it's just a plain\n`rust` code sample.\n\nUsers who are viewing the JS platform at version 1.0.0 will see code sample 2 but not 3, etc.\n\nUsers viewing the book on a platform that does not have a code sample will see a small warning\nsaying something like \"sorry, we don't have a code sample for this yet :cry:\".\n\nto prevent them from being cluttered with boilerplate,\nyou may (judiciously) omit code from code samples by\ncommenting lines with `--`.\nThese lines will still be included in the automated tests,\nbut hidden on `kwap-rs`.\n\n```\n` ` `kwap/javascript^2\n-- const foo = 12;\nif (foo + 12 !== 24) {\n  throw new Error('foo should be 12');\n}\n` ` `\n` ` `kwap/rust^1\nfn main () {\n  -- let foo = 12_i32;\n  assert_eq!(foo + 12, 24);\n}\n` ` `\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoad-lib%2Ftoad.dev-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftoad-lib%2Ftoad.dev-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoad-lib%2Ftoad.dev-docs/lists"}