Restructure deposit documentation with a clearer strategy
First verify if the deposit documentation can be structured with Divio's ideas: https://documentation.divio.com/introduction/
As presented by Daniele Procida on: https://www.youtube.com/watch?v=t4vKPhjcMZg
The current deposit table of contents is the following: swh.deposit (Description subsection and Contents subsection) In the Description the following items are hilghligthed:
- loader workers
- lister workers
- SWHID
- reference the source code => https://hal.archives-ouvertes.fr/hal-02446202
- scientific paper => https://www.softwareheritage.org/2020/05/26/citing-software-with-style/
- save code now feature
- codemeta
- SWORD v2 In the Description, the list of direct links:
- User Manual page
- API Documentation reference pages
- Hacking on swh-deposit
- Deployment of the swh-deposit
In the Contents, here is the full TOC:
- User Manual
- Deposit metadata
- API Documentation
- Hacking on swh-deposit
- Deployment of the swh-deposit
- Blueprint Specifications
- Tests scenarios for client
Reference Documentation
Migrated from T2894 (view on Phabricator)
Edited by Phabricator Migration user