@@ -41,25 +41,20 @@ git commit -m '<some message>'
41
41
gh pr create # if you use the GitHub CLI
42
42
```
43
43
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:
44
+ When reviewed and mereged, you are ready to publish documentation to the live site:
53
45
``` bash
54
46
# From repository root INSIDE your Docker instance
55
47
make docs-publish
56
48
```
57
49
58
- Note the the hash of your commit :
50
+ You should eventually read :
59
51
``` bash
60
- git rev-parse --short HEAD # supposingly it is the last commit of the branch
52
+ Test locally: make docs-serve
53
+ Push to live site: cd www/docs_site/; git add -A; git commit -m ' update to <commit>' ; git push; cd -
61
54
```
62
55
56
+ The commit hash in the last line should be the hash of your commit in the skip repository.
57
+
63
58
This will suggest running:
64
59
``` bash
65
60
# Test locally
83
78
84
79
## TypeDoc Tags
85
80
86
- For a complete reference of TypeDoc tags, see the [ official documentation] ( https://typedoc.org/guides/tags/ ) .
81
+ You may refer to the [ official documentation] ( https://typedoc.org/guides/tags/ ) of TypeDoc tags for more information.
82
+
83
+
84
+ ## FAQ
85
+
86
+ ### What if my ` docs_site ` is not on the ` main ` branch ?
87
+ Clean up your repository is good idea at this point and then start the process again:
88
+ ``` bash
89
+ ` ` ` bash
90
+ git pull --rebase
91
+ git clean -Xdn # -n for a dry-run and double-check what's to be cleaned out
92
+ git clean -Xdf # the actual cleaning
93
+ ` ` `
94
+
95
+ # ## What if the hash is not in the commit message suggested along the process ?
96
+ You can get it from the skip repository:
97
+ ` ` ` bash
98
+ git rev-parse --short HEAD # supposingly it is the last commit of the branch
99
+ ` ` `
0 commit comments