Note: This post is referring specifically to the Docs section of the Docs, not the entire documentation site with the roadmap, both tutorials, etc.
As we’re growing our documentation it’s started to get a little unwieldy, particularly in the catch-all “Docs” section. (As a larger meta-point, having a Docs section of the docs doesn’t really make a ton of sense to me).
Right now we’ve got 25 sections. In my mind I could imagine breaking this list down to a couple different categories. These lines will be fuzzy and I’d love to get others thoughts on this particularly @dom @rob @thedavid @mojombo @clairefro
Here’s my broad view right now, I think you could potentially made a further distinction in the concepts category between:
- Mostly prose explanations
- More like comprehensive API documentation
But the more important categorization for me is between config and concepts, with concepts being long form explanatory content and config being targeted instructions for specific edge cases.
- CLI Commands
- Data Migrations
- Environment Variables
- Flash: Messaging Bus
- Mocking GraphQL requests
- Redwood Router
- Schema Relations
- App Configuration: redwood.toml
- Assets and Files
- Connection Pooling
- Custom Web Index
- Local Postgres Setup
- Serverless Functions
- Webpack Configuration
Reference list of available plugins
Cries for help
And lastly I think Contributing should be as easy to find as possible and right now putting it in the middle of this list makes it unlikely the people who need it most will find it.