@@ -32,6 +32,11 @@ make docs-run # Run the docs site locally
3232make docs # Regenerate API documentation
3333```
3434
35+ A faster but not robust way to regenerate the api docs is:
36+ ``` bash
37+ cd /path/to/repo/root/www && npx docusaurus generate-typedoc
38+ ```
39+
3540### Publishing Documentation
3641
3742Before, commit your changes and send them for review
@@ -41,25 +46,20 @@ git commit -m '<some message>'
4146gh pr create # if you use the GitHub CLI
4247```
4348
44- When reviewed and mereged, rebase and clean up your repository:
45- ``` bash
46- git pull --rebase
47- git clean -Xdn # -n for a dry-run and double-check what's to be cleaned out
48- git clean -Xdf # the actual cleaning
49- ```
50-
51-
52- To publish documentation to the live site:
49+ When reviewed and mereged, you are ready to publish documentation to the live site:
5350``` bash
5451# From repository root INSIDE your Docker instance
5552make docs-publish
5653```
5754
58- Note the the hash of your commit :
55+ You should eventually read :
5956``` bash
60- git rev-parse --short HEAD # supposingly it is the last commit of the branch
57+ Test locally: make docs-serve
58+ Push to live site: cd www/docs_site/; git add -A; git commit -m ' update to <commit>' ; git push; cd -
6159```
6260
61+ The commit hash in the last line should be the hash of your commit in the skip repository.
62+
6363This will suggest running:
6464``` bash
6565# Test locally
8383
8484## TypeDoc Tags
8585
86- For a complete reference of TypeDoc tags, see the [ official documentation] ( https://typedoc.org/guides/tags/ ) .
86+ You may refer to the [ official documentation] ( https://typedoc.org/guides/tags/ ) of TypeDoc tags for more information.
87+
88+
89+ ## FAQ
90+
91+ ### What if my ` docs_site ` is not on the ` main ` branch ?
92+ Clean up your repository is good idea at this point and then start the process again:
93+ ``` bash
94+ ` ` ` bash
95+ git pull --rebase
96+ git clean -Xdn # -n for a dry-run and double-check what's to be cleaned out
97+ git clean -Xdf # the actual cleaning
98+ ` ` `
99+
100+ # ## What if the hash is not in the commit message suggested along the process ?
101+ You can get it from the skip repository:
102+ ` ` ` bash
103+ git rev-parse --short HEAD # supposingly it is the last commit of the branch
104+ ` ` `
0 commit comments