TheIOFoundation / ProjectLockdown

Project Lockdown (an initiative from The IO Foundation) is a civic tech, interactive platform providing an overview of the state of Human and Digital Rights around the globe. It evaluates policies obtained from official sources that may impact their observance. It provides, among other tools, a layered map interface that allows for a visual representation of the policies adopted, assisting a broad range of stakeholders in understanding the global state of their Rights. This empowers them to become active agents of global change.
https://ProjectLockdown.world
GNU General Public License v3.0
36 stars 14 forks source link

DOC: restructure Stoplight docs to be more modular #355

Open jeff-knurek opened 3 years ago

jeff-knurek commented 3 years ago

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 commented 3 years ago

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