This serves as an umbrella for various efforts to improve Stripes front-end developer documentation.
The target audience for stripes documentation will fall into three main categories:
- Stripes users (dev-ops, platform implementers, SaaS providers, etc.)
- App developers (those who develop apps using the Stripes framework)
- Core developers (those who develop stripes-* modules)
Existing documentation needs to be reviewed for inconsistencies and errors in procedures, starting first with environment setup. In general, developers will be directed toward CLI-based workflows first. Where applicable manual steps will be retained as an alternative and for better understanding.
Code examples (embedded or linked to) need review for compliance with Stripes framework-based implementations. This includes code generated by the CLI.
Gaps in our existing documentation will need to be identified.
Overview, getting started, release procedures, and similar high-level documentation will be maintained in the new stripes repo. Links to stripes-* repos will take users to more detailed module-specific documentation. This will involve migrating some existing getting started documentation out of stripes-core and stripes-cli.