mirror of
https://github.com/kc4x4sar/d4h-typescript.git
synced 2026-07-12 17:21:05 -07:00
Separate classes for groups of methods (#1)
* added resourcetype interface that's imported and reused * added membergroupmembership; comments formatting typedoc output; updated types * separate classes for groups of methods * additional methods added, suggested changes made, typedoc documentation improved
This commit is contained in:
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Contributing
|
||||
group: Contributing
|
||||
---
|
||||
|
||||
# Contributing
|
||||
|
||||
## Updating Documentation
|
||||
|
||||
Documentation is setup to be hosted on github pages, it is generated using typedoc.
|
||||
|
||||
Typedoc documentation can be found here: <https://typedoc.org/>
|
||||
|
||||
### Guides
|
||||
|
||||
The files for the guides are located in the documentation folder, they are written in markdown
|
||||
|
||||
### Module Documentation
|
||||
|
||||
To update the typedoc generated documentation for the module, run the following commands in the root of the repo:
|
||||
|
||||
npm install # Install only needs to be run first time.
|
||||
npm run docs
|
||||
Reference in New Issue
Block a user