Skip to content

Commit

Permalink
docs: update main readme
Browse files Browse the repository at this point in the history
  • Loading branch information
postspectacular committed Feb 13, 2025
1 parent 56506f7 commit 63f46cb
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

- [About](#about)
- [Getting Started](#getting-started)
- [Documentation](#documentation)
- [Project templates](#project-templates)
- [#HowToThing](#howtothing)
- [Blog posts](#blog-posts)
Expand Down Expand Up @@ -35,7 +36,7 @@
- [Building](#building)
- [Building example projects](#building-example-projects)
- [Testing](#testing)
- [Documentation](#documentation)
- [Building API docs](#building-api-docs)
- [Extracting code examples from readme files & comments](#extracting-code-examples-from-readme-files--comments)
- [Acknowledgements](#acknowledgements)
- [License](#license)
Expand Down Expand Up @@ -151,7 +152,11 @@ least for all the larger and/or more important ones), as well as [hundreds of
small usage examples/snippets in doc strings & readme
files](#extracting-code-examples-from-readme-files--comments).

**Documentation and changelogs for all packages: [docs.thi.ng](https://docs.thi.ng/)**
### Documentation

- [Generated API docs (overview)](https://docs.thi.ng/)
- [Single page API docs for all pacakges (work-in-progress)](https://docs.thi.ng/umbrella)
- [Hundreds of usage examples/snippets](#extracting-code-examples-from-readme-files--comments)

If you're unsure about something, please [reach
out](#community-contributing-getting-help)! Any constructive feedback is always
Expand Down Expand Up @@ -648,11 +653,11 @@ yarn test:only
yarn workspace @thi.ng/rstream run test
```

### Documentation
### Building API docs

Autogenerated documentation (using
[TypeDoc](https://github.com/TypeStrong/typedoc)) will be saved under
`/packages/*/doc/` and is also available at [docs.thi.ng](https://docs.thi.ng).
`/packages/*/doc/` ([more info](#documentation)).

```bash
yarn doc
Expand Down

0 comments on commit 63f46cb

Please sign in to comment.