fix: disable dashboard next version doc config #1915
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR disables the next version documentation task for the apisix-dashboard project to ensure that the documentation site renders properly. Key changes include:
- In scripts/sync-docs.js, a skip condition is added to bypass extracting next version documents for apisix-dashboard.
- In doc/docusaurus.config.js, the includeCurrentVersion flag is set to false for the dashboard documentation.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| scripts/sync-docs.js | Added a skip condition for apisix-dashboard to disable next version docs |
| doc/docusaurus.config.js | Disabled includeCurrentVersion for dashboard docs configuration |
| @@ -137,6 +137,7 @@ const tasks = new Listr([ | |||
| }, | |||
| { | |||
| title: `Extract ${project.name} next version documents`, | |||
| skip: () => project.name === 'apisix-dashboard', | |||
There was a problem hiding this comment.
Consider adding an inline comment to explain why the extraction is skipped for apisix-dashboard, referencing the temporary solution from the linked review.
Copilot uses AI. Check for mistakes.
| @@ -99,6 +99,7 @@ module.exports = { | |||
| path: 'docs/apisix-dashboard', | |||
| showLastUpdateAuthor: true, | |||
| showLastUpdateTime: true, | |||
| includeCurrentVersion: false, | |||
There was a problem hiding this comment.
Adding an explanatory comment for disabling includeCurrentVersion would clarify that this setting is necessary to render the documentation site properly as a temporary measure.
Copilot uses AI. Check for mistakes.
Fixes: #[Add issue number here]
Changes:
In order for the documentation site to render properly.
Temp solution from #1912 (review).
Screenshots of the change: