-
Notifications
You must be signed in to change notification settings - Fork 379
Remove versioning for community doc #5294
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| Please refer to the [Contributing Guide](https://thunderid.dev/docs/next/community/overview) for guidelines on how to contribute to this project. | ||
| Please refer to the [Contributing Guide](https://thunderid.dev/community/overview) for guidelines on how to contribute to this project. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,10 @@ const {processMarkdownFile} = require('./mdxProcessor'); | |
| * → build/docs/v1.0.x/getting-started/foo.md | ||
| * → served at /docs/v1.0.x/getting-started/foo.md | ||
| * | ||
| * community/overview.mdx (permalink /community/overview) | ||
| * → build/community/overview.md | ||
| * → served at /community/overview.md | ||
| * | ||
| * Deriving the output path from `doc.permalink` (rather than re-deriving a | ||
| * slug from the source file path) keeps this in lockstep with | ||
| * docusaurus-plugin-llms-txt, including for index/category-root docs whose | ||
|
|
@@ -73,12 +77,14 @@ module.exports = function pluginMarkdownExport(context) { | |
|
|
||
| async allContentLoaded({allContent}) { | ||
| const docsPlugin = allContent?.['docusaurus-plugin-content-docs']; | ||
| const docsContent = docsPlugin?.default; | ||
| if (!docsContent?.loadedVersions) { | ||
| // Collect every docs plugin instance: the versioned "default" one and the | ||
| // unversioned "community" one, which has a single "current" version. | ||
| const versions = Object.values(docsPlugin ?? {}).flatMap((instance) => instance?.loadedVersions ?? []); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win Add regression coverage for all docs plugin instances. Test a default instance plus a As per coding guidelines, “Write tests for new features and bug fixes, targeting at least 80% coverage.” 🤖 Prompt for AI AgentsSource: Coding guidelines |
||
| if (versions.length === 0) { | ||
| console.warn('[markdown-export] docs plugin content not found; skipping'); | ||
| return; | ||
| } | ||
| loadedVersions = docsContent.loadedVersions; | ||
| loadedVersions = versions; | ||
| }, | ||
|
|
||
| async postBuild({outDir}) { | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Resolve the docs-lint failure before merge.
The pipeline rejects
CONTRIBUTING.mdbecause it has no frontmatter. If this root guide is not a Docusaurus page, exclude it from changed-file docs lint. Otherwise, add valid frontmatter.🧰 Tools
🪛 GitHub Actions: 🥒 Docs Lint (Changed Files Only) / 0_Docs lint.txt
[error] 1-1: Structural docs lint failed: missing frontmatter. The file must start with '---'. Command: ./scripts/docs-lint.sh.
🪛 GitHub Actions: 🥒 Docs Lint (Changed Files Only) / Docs lint
[error] 1-1: Structural docs lint failed: file is missing frontmatter and must start with '---'. Command './scripts/docs-lint.sh' failed with exit code 1.
🤖 Prompt for AI Agents
Source: Pipeline failures