Make README a quick start and split detailed documentation - #307
Conversation
Coverage Report for CI Build 34013083643Coverage increased (+0.5%) to 94.694%Details
Uncovered Changes
Coverage RegressionsNo coverage regressions found. Coverage Stats💛 - Coveralls |
|
For the sub-pages, can you adopt a docs breadcrumb convention similar to the docs in https://github.com/hifiwi-fi/breadcrum.net/tree/master/packages/web/client/layouts/docs |
|
Implemented in 04ddfa0, following the shared-layout convention from breadcrum.net. All topic pages, the docs index, and both migration guides now select Validation passed: full |
Summary
Closes #299.
This documentation change is independent of the watch stack and based on
master.docs/.Validation
npm testpassed outside the restricted runner.npm run build:domstackpassed with all new documentation pages included.public/index.htmlwith the documented content and default layout.Notes
The example reference uses
docs/example-projects/because the documentation build intentionally excludes directories namedexamples.The existing migration guides remain separate documents with updated moved-reference links and the shared breadcrumb layout.