feat(docs): deployment to github pages#25
Conversation
📝 WalkthroughWalkthroughThis update introduces two new GitHub Actions workflows for documentation testing and deployment. Docusaurus configuration is modified to specify the deployment branch and URL formatting, and two footer navigation links are updated. Additionally, a commented-out sidebar entry is removed from the documentation sidebar configuration. Changes
Sequence Diagram(s)sequenceDiagram
participant GitHub
participant Workflow (deploy-docs.yaml)
participant Build Job
participant Deploy Job
participant GitHub Pages
GitHub->>Workflow (deploy-docs.yaml): Push to main branch
Workflow (deploy-docs.yaml)->>Build Job: Start build job
Build Job->>Build Job: Checkout repo, setup Node.js, install deps, build docs
Build Job->>Workflow (deploy-docs.yaml): Upload build artifact
Workflow (deploy-docs.yaml)->>Deploy Job: Start deploy job (after build)
Deploy Job->>GitHub Pages: Deploy artifact using actions/deploy-pages@v4
sequenceDiagram
participant GitHub
participant Workflow (deploy-docs-test.yaml)
participant Test-Deploy Job
GitHub->>Workflow (deploy-docs-test.yaml): Pull request to main branch
Workflow (deploy-docs-test.yaml)->>Test-Deploy Job: Start test-deploy job
Test-Deploy Job->>Test-Deploy Job: Checkout repo, setup Node.js, install deps, build docs
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
.github/workflows/deploy-docs.yaml (1)
3-8: Consider scoping deployment to doc changes.
Triggering on every push tomainredeploys your site even when non-docs code changes. You can limit runs to docs-related updates:on: push: branches: - main paths: - 'docs/**' - '.github/workflows/deploy-docs.yaml'
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.github/workflows/deploy-docs-test.yaml(1 hunks).github/workflows/deploy-docs.yaml(1 hunks)docs/docusaurus.config.ts(2 hunks)docs/sidebars.ts(0 hunks)
💤 Files with no reviewable changes (1)
- docs/sidebars.ts
🧰 Additional context used
🪛 actionlint (1.7.7)
.github/workflows/deploy-docs-test.yaml
19-19: "working-directory" is not available with "uses". it is only available with "run"
(syntax-check)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: integration-contracts / integration
- GitHub Check: integration-packages / Build
🔇 Additional comments (3)
docs/docusaurus.config.ts (3)
128-130: Verify the updated ‘Architecture’ doc path exists.
You’ve changed the footer link from/docs/concepts/architectureto/docs/concepts/architecture_overview. Make sure the corresponding file (docs/concepts/architecture_overview.md) exists and is included in your sidebar.
136-138: Validate the “Custom Backend” URL update.
The footer now points to/docs/concepts/architecture_custom_backend. Confirm you’ve created or moved the page to that path and updated any sidebar entries accordingly.
25-26:Details
✅ Verification successful
Ensure Docusaurus version compatibility with new config keys.
The propertiesdeploymentBranchandtrailingSlashrequire Docusaurus v2.1+ to work as expected. Please confirm your@docusaurus/coreversion indocs/package.jsonsupports these keys to avoid build errors.Run:
🏁 Script executed:
jq -r '.dependencies["@docusaurus/core"]' docs/package.jsonLength of output: 67
No action needed: Docusaurus v3.7.0 supports
deploymentBranchandtrailingSlash
Verified that@docusaurus/coreis at version 3.7.0, which fully supports both config keys—no changes required.
2 participants
feat(docs): deployment to github pages
Summary by CodeRabbit