docs: fix broken images/links, wrong download workflow, and stale tooling references#616
Open
ZayanKhan-12 wants to merge 5 commits into
Open
docs: fix broken images/links, wrong download workflow, and stale tooling references#616ZayanKhan-12 wants to merge 5 commits into
ZayanKhan-12 wants to merge 5 commits into
Conversation
Both pages embedded docs/_images/..., which resolves relative to the page's own directory (docs/docs/_images and docs/user-guide/docs/_images respectively) - the image 404s on the MkDocs site and on GitHub. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
examples/ lives at the repository root, so relative links from inside docs/ (docs/examples/...) resolve to nonexistent paths on both GitHub and the docs site; scan-account.md additionally displayed a path (examples/output/example-authz-details-results.json) that has never existed. Link to the canonical GitHub locations. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
'download --output' takes an existing directory (click.Path(exists=True), cloudsplaining/command/download.py), not an output filename, and the downloaded file is always named <profile>.json - so the documented '--output default-account-details.json' fails and the follow-up scan referenced a file that would never exist. Use the default directory and the real default.json filename. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
'\ ' at end of line escapes the space instead of continuing the command, so the multi-line create-multi-account-config-file and scan-multiple-accounts examples break when copy-pasted. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The contributing docs referenced 'make setup-env/test/test-js/build-js/ serve-js/build-docs/serve-docs/generate-report/security-test', but the repository has no Makefile; tooling is uv + just (justfile; test.yml runs 'just unit-tests' etc.). Map each command to its actual recipe and drop the reference to a utils test script that does not exist. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Thanks for the contribution! Before we can merge this, we need @zk-khan to sign the Salesforce Inc. Contributor License Agreement. |
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
2 participants
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.
Five commits, each independently revertible:
docs/index.mdanddocs/user-guide/scan-account.mdembeddocs/_images/cloudsplaining-report.gif, which resolves relative to each page's own directory (docs/docs/_images/…,docs/user-guide/docs/_images/…) — the image is broken on both the MkDocs site and GitHub. Fixed to_images/…/../_images/….examples/links —examples/lives at the repository root, so relative links from insidedocs/404;scan-account.mdadditionally displayedexamples/output/example-authz-details-results.json, a path that has never existed. Linked to the canonical GitHub locations.docs/user-guide/overview.mdanddocs/report/triage.mddocumentcloudsplaining download --profile default --output default-account-details.json, but--outputis an existing directory (click.Path(exists=True),cloudsplaining/command/download.py) and the output file is always<profile>.json— so that command fails, and the follow-upscan --input-file default-account-details.jsonreferences a file that would never exist. Corrected todownload --profile default+scan --input-file default.json.README.mdanddocs/user-guide/scan-multiple-accounts.mdend multi-line commands with backslash-space, which escapes the space instead of continuing the line.make setup-env/test/test-js/build-js/serve-js/build-docs/serve-docs/generate-report/security-test, but there is no Makefile; tooling is uv +just(test.ymlrunsjust unit-testsetc.). Each command mapped to its actual recipe; removed the mention of a utils test script that doesn't exist.Verification: all image/link targets checked against the tree; the
--outputbehavior checked against the click definition and the filename logic indownload.py; everyjustrecipe name checked against thejustfileand CI workflows;python -m pytest testpasses locally (130/130; Python 3.14, macOS arm64).Prepared with AI assistance (Claude); every claim mechanically verified as described.