otter
otter copied to clipboard
[Feature]: Feedback from Roland regarding the documentation
Context
For the release of the Otter v10, we received feedback from Roland who did a quick review of the Otter repository documentation.
Proposal
Summarize of the feedbacks:
- [x] The links labeled "here" in the main readme should have a label more explicit
- [x] Missing
@o3r/telemetry
package in the/docs/readme.md
package list - [ ] Architecture schema is to big to be read on github interface, it should be split or find a better way to display it
- [x] Missing interconnection between the showcase different pages
- [x] Provide documentation regarding issue that can appear we npm/yarn is used behind a proxy
- [ ] The main readme ToC could include /docs/ documentation nativation
- [ ] The main readme could include testimonials from users
- [x] Add badges to main readme and module readme files
- [ ] Change the /docs/ folder structure as following
|-- migration-guides (moved from top level to docs)
|-- units
|-------ab-testing
|-------analytics
….
|-- contributing.md (moved from top level to docs)
|-- security.md (moved from top level to docs)
- [x] Update SECURITY.md with the latest versions
- [x] Reduce the number of
tsconfig.*.json
file at root level
The point Reduce the number of tsconfig.*.json file at root level
is handle at IDE level via the VsCode's fileNesting feature.