Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: restructure Stoplight docs to be more modular #355

Open
jeff-knurek opened this issue Apr 18, 2021 · 1 comment · Fixed by #356
Open

DOC: restructure Stoplight docs to be more modular #355

jeff-knurek opened this issue Apr 18, 2021 · 1 comment · Fixed by #356
Assignees
Labels
💧 Priority: Medium This task has Medium priority. Project: PLD Issue related to Project Lockdown. ⌨ Team: Devs Task related to Team Developers. 📑 Team: Docs Task related to Team Documentation.

Comments

@jeff-knurek
Copy link
Contributor

logo

Problem

The documentation in Stoplight

  1. includes content that is not relevant to the project
  2. is unclear in what it really represents unless to new people
  3. is saved in one really giant json file
  4. because it's in one file, it's not "close to the code" that it represents

Proposed solution

Resources

@jeff-knurek jeff-knurek added Project: PLD Issue related to Project Lockdown. ⌨ Team: Devs Task related to Team Developers. 💧 Priority: Medium This task has Medium priority. 📑 Team: Docs Task related to Team Documentation. labels Apr 18, 2021
This was linked to pull requests Apr 19, 2021
@jeff-knurek
Copy link
Contributor Author

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

@jeff-knurek jeff-knurek reopened this Apr 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💧 Priority: Medium This task has Medium priority. Project: PLD Issue related to Project Lockdown. ⌨ Team: Devs Task related to Team Developers. 📑 Team: Docs Task related to Team Documentation.
2 participants