Feature: user documentation - Githubissues

GNS-Science / nzshm-model

logic tree definition and changelog for the New Zealand NSHM

1 stars 1 forks source link

Feature: user documentation #26

Closed chrisbc closed 2 months ago

chrisbc commented 7 months ago

as we want this model to be usable by a wider audience it will need some decent documentation covering:

[x] update the Readme
[x] user APIs (from source docs)
- [x] #42
[x] installation
~development and contributing~
~testing~
~scripts~
~a diagram and explanation of the psha_adapter pattern~
~github-pages~

Done when:

[x] setup poetry for mkdocs (based on nzshm-documentation)
[x] create index in mkdocs.yml
[x] add content (as above)

see #72

chrisbc commented 2 months ago

this was included in PR #71