pisanix
pisanix copied to clipboard
Add docs automation workflow
Development Task
For better documentation, there is a need for docs automation workflow. Trying to build a Github Action to implementing the following steps:
- Run
npm run build
underdocs
- Copy all generated files under
docs/build
to cloned pisanix.io - Push the changes of pisanix.io to its branch
gh-pages
@mlycore Can you assign this issue to me, I want to try.
@mlycore Can you assign this issue to me, I want to try.
Hi @strongduanmu, Thanks a lot. Since the release v0.1.1
, the docs has changed to the versioned docs, I will add some steps for generate versioned docs.
@xuanyuan300 Ok, thank you for your remind.
Prepare step: cd docs
- Run
npm i
to install dependencies. - Run
npm docusaurus docs:version x.x.x
. When tagging a new version, the document versioning mechanism will:
- Copy the full docs/ folder contents into a new versioned_docs/version-[versionName]/ folder.
- Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as versioned_sidebars/version-[versionName]-sidebars.json.
- Append the new version number to versions.json. Please see https://docusaurus.io/docs/versioning
- Run npm run build.
- Copy all generated files to cloned pisanix.io.
- Push the changes of pisanix.io to its branch gh-pages.
@mlycore @wbtlb @xuanyuan300 I'm so sorry to everyone, because I've been very busy recently, this issue can't be completed in time. If there is a dead time for this task, I think it can be done by other friends. 😂
@mlycore @wbtlb @xuanyuan300 I'm so sorry to everyone, because I've been very busy recently, this issue can't be completed in time. If there is a dead time for this task, I think it can be done by other friends. 😂
Dont worry, I'll reassign it.