Create a developer guidance section for the hosted docs
This commit is contained in:
parent
9788e0d2b7
commit
bc36a1e9d0
14 changed files with 3569 additions and 189 deletions
9
apidocs/dev/README.md
Normal file
9
apidocs/dev/README.md
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
# Developer Guidance
|
||||
|
||||
This site provides information that is useful for developing the OpenFlexure Microscope.
|
||||
|
||||
### Viewing and Modifying Locally
|
||||
|
||||
If you want to view these documents in your machine (very useful when editing them). You will need to serve the `apidocs` directory. Navigate to the `apidocs` directory and run `python -m http.server`.
|
||||
|
||||
All developer guidance documentation is written in markdown and then displayed with Docsify. More information on Docsify can be found at https://docsify.js.org.
|
||||
Loading…
Add table
Add a link
Reference in a new issue