This project is forked from fibjs and only reserves the doc-related files.
To enrich fibjs's document, we need carray the code in test cases onto document as example usage.
- Fetch submodule
Type git submodule init git submodule update to fetch submodule docs into project
- Generate document
Type fibjs docs.js under 'tools' directory in your terminal command line, and document are generated in director 'docs/web/dist', then open the index.html with your web browser and you can review what the document has changed to.
- Modify idl
Then modify the *.idl files under 'idl' directory.
- Regenerate document
Same as 'Generate document'
Open issue here, comment with names of modules or objects, and you will be in charge of modifying the corresponding idl files of the names.
Your contribution are welcome!