The documentation is an area which can always benefit from extra eyes, extra knowledge and extra examples.
Contributing to the documentation is welcome, but when making changes to documentation, please ensure that all changes are made only to:
- Updating /docs.wrm/**.wrm
- Adding links: /docs.wrm/links/*.txt
- Updating API jsdocs: /** ... */ comment blocks within /src.ts/
Generally changes to /docs.wrm/config.wrm should not be made, and if you feel it is necessary, please consider opening a Ethers Discussion first.
Similarly, when adding a new sections, a Ethers Discussion is preferred.
All changes should be in the Flatworm Markdown Dialect.
Building the Documentation
Currently, the documentation is built using an experimental v2 of the Flatworm documentation system, a system originally specifically made to maintain the Ethers documentation.
The new tsdocs branch has the ability to parse jsdocs from from TypeScript source files to create an API reference.
Building with the v2 Flatworm
/home/ricmoo> git clone https://github.com/ricmoo/flatworm.git
/home/ricmoo> cd flatworm
/home/ricmoo/flatworm> git checkout tsdocs
/home/ricmoo/flatworm> npm install
/home/ricmoo/flatworm> node lib/cli-test PATH_TO_WRM_ROOT
Eventually the code for the v2 branch will be cleaned up, and it
will be much easier to include as a ``devDependency`` for Ethers.
In the meantime, expect new changes to be made frequently to the
``tsdocs`` branch, so for stability you may wish to checkout a