Repository navigation
DOC: restructure Stoplight docs to be more modular #355
Description
Problem
The documentation in Stoplight
- includes content that is not relevant to the project
- is unclear in what it really represents unless to new people
- is saved in one really giant json file
- because it's in one file, it's not "close to the code" that it represents
Proposed solution
- make use of the
Table of Contentsfile (toc) in Stoplight: https://meta.stoplight.io/docs/platform/4.-documentation/d.table-of-contents.md - split the giant json file into smaller parts, and move those smaller parts to where the code they represent are
Activity
jeff-knurek commentedon Apr 26, 2021
merging that last commit closed this issue, but that was only part of the work needed on this task, so I'm re-opening
next step is that now that a TOC file is in place, to split the giant json into smaller chunks. an idea that might work is to first only split the db models & the api endpoints. that might make it just another smaller PR which can also allow for making sure the TOC is also working with the changes being made