lightbasenl / lightbasenl/platforms
Keep documentation on symbols in sync with the README's
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
We manually copy and paste the documentation changes from, for example, the pull-through-cache to the README. It might be nice to use TypeDoc for this. However, not really a fan of the default output, or the output of typedoc-plugin-markdown.
Like Ion we can probably use TypeDoc's parsers to massage the available info in a different output format. This also requires some rules around docs;
- Which symbols are included in the generated docs and in what order?
- Do we want to generate the whole README, or just the API sections?
- What rules do we need to enforce on TS doc blocks?
- ...
We probably should wait for at least one package before we start working on this, so we don't design this purely for the pull-through-cache.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the README API sections and the pull-through-cache documentation, then compare the TypeDoc parser approach used in Ion's www/generate.ts. Define which symbols and TypeScript doc blocks are included and whether generation covers the whole README or only API sections; done means those rules are agreed and demonstrated for at least one package.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100