docs: refresh SDK READMEs and fix broken argos-ci.com/docs links#338
Merged
Conversation
The argos-ci.com/docs site was restructured, so most deep links now 404. This updates every link to a verified-valid URL and refreshes the docs. - Fix all argos-ci.com/docs links across READMEs, package.json homepage fields, JSDoc @see comments, and example configs (new /sdks-reference, /learn, and /quickstart/*-quickstart paths) - Remove the in-repo MDX doc pages (packages/*/docs/index.mdx) - Update all READMEs: new slogan and SDK usage examples - Remove the unused .github/workflows/build-docs.yml workflow The Vitest docs page does not exist yet, so its links point to the docs home for now and should be updated once the page is created. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes ARG-453.
The
argos-ci.com/docssite was restructured (now a GitBook-style site), so nearly every deep link in the repo returned a 404. I pulled the authoritative page list from the site'sllms.txtand verified every replacement URL with live fetches.Changes
1. Fixed all
argos-ci.com/docslinksEvery distinct docs URL in the repo is now a verified-valid path — across READMEs,
package.jsonhomepagefields, JSDoc@seecomments, and example configs. Main remappings:/docs/{sdk}→/docs/sdks-reference/{sdk}(e.g.argos-cli→sdks-reference/argos-command-line-interface-cli,node-sdk→sdks-reference/node.js-sdk)/docs/build-modes→/docs/learn/platform-fundamentals/build-modes/docs/run-on-preview-deployment→/docs/learn/how-to-guides/ci-pipelines/run-on-preview-deployments/docs/screenshot-pages-script→/docs/learn/how-to-guides/visual-coverage/capture-screenshots-from-urls/docs/gitlab→/docs/learn/integrations/gitlab-integration/docs/quickstart/{x}→/docs/quickstart/{x}-quickstart(Storybook variants nested understorybook-quickstart/)2. Removed in-repo MDX doc pages
Deleted the 6
packages/*/docs/index.mdxfiles (and their now-emptydocs/dirs). StorybookConfigure.mdxstory files are unrelated and kept.3. Updated all READMEs
packages/vitest/README.mdand verified against each package's actual exports.browserandutilare internal building blocks, so they get an honest "internal package" note instead of a fabricated example. The root README now lists all integration SDKs.4. Removed the unused workflow
Deleted
.github/workflows/build-docs.yml. The rootpackage.jsonbuild-docsnpm script is TypeDoc (generates the js-sdk-reference API site) — unrelated, so it stays.Note on Vitest
The Vitest docs page doesn't exist yet, so its links (README +
package.jsonhomepage) point to the/docshome for now. These should be updated to the Vitest-specific URL once that page is created.Verification
argos-ci.com/docsURL confirmed valid; no broken paths or stale#api-overviewanchors remain.prettier --checkpasses on all changed files.🤖 Generated with Claude Code