diff --git a/backlog.tasks b/backlog.tasks index dc8cee8..e8b4f12 100644 --- a/backlog.tasks +++ b/backlog.tasks @@ -25,9 +25,30 @@ Enhancements: Documentation: ☐ Clean up CONTRIBUTING.md and README.md, create docs -☐ Add usage examples to README.md + ☐ Review existing documentation for accuracy and completeness + ☐ README.md should be the main entry point for users, and CONTRIBUTING.md should be the main entry point for contributors + ☐ A lot of decisions are documented in the current README.md and CONTRIBUTING.md, that are not part of a main entry for users, how to use the library nor part of a main entry for contributors, + ☐ evaluate a new structure for the docs, and move the relevant information to the new docs + ☐ have a look at other well known repositories for inspiration on how to structure the docs + ☐ often times a docs folder is used, but this usually contains further user of the library documentation, that is deployed to a website. Deployment is out of scope for now + ☐ More important is to have the documentation of our decisions, shortcomings and known issues, not sure where to put this. at work we have ADRs, maybe that? Please suggest something after having looked at other well known repos + ☐ make sure to preserve that information in the new docs + ☐ README.md + ☐ I really like the order perl documentation does it: name with a single line description, version, Synopsis, Description, examples, API reference, license + (example: https://metacpan.org/pod/Scalar::Util) + ☐ should include a clear description of the library, its purpose, and how to use it + ☐ Add usage examples to README.md + ☐ version needs to be kept in sync with package.json in release.sh + ☐ Not every section in current README fits in the above order, so put them in another file + ☐ CONTRIBUTING.md + ☐ should include instructions for how to contribute to the project, including how to set up a development environment, run tests, and submit pull requests + ☐ should include guidelines for code style and formatting and a hint, that vscode extensions are suggested from .vscode/extensions.json + ☐ Not every section in current CONTRIBUTING.md fits in, so put them in another file + + + ☐ Create `examples/` directory with runnable snippets -☐ Add comparison section vs. other TS pattern-matching libs +☐ Add comparison section vs. other TS pattern-matching libs in Readme.md ☐ Write migration guide for users coming from discriminated unions ☐ Create backlog tasks for implementation