docs: modernize README + docs (Pathfinding.cloud, multi-account, glossary links; drop triage worksheet)#595
Merged
Merged
Conversation
…lesforce note - README: credit Privilege Escalation detection to Pathfinding.cloud - README: remove the "this repo/project has been restored by Salesforce" banner Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Remove "triage worksheet" wording (no longer generated), note multi-account scanning, add Credentials Exposure to the risk list, and link each risk to its glossary page. Reconciled with this branch's Pathfinding.cloud wording. Harvested from #558; the obsolete pyproject and .readthedocs.yml uv-pin hunks are dropped (master already requires uv >=0.11.0, so pinning to 0.10 would break the docs build), and the cli.py docstring change is handled separately on the feature branch. Co-authored-by: nikhil6393 <nikhil900285@gmail.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
kmcquade
changed the title
The scan no longer generates a triage CSV worksheet. Trim the stale phrase from the module, group-callback, and main() docstrings. Harvested from #558, applied here because this branch owns cli.py (keeps it conflict-free with the docs PR). Co-authored-by: nikhil6393 <nikhil900285@gmail.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
README + docs modernization. Combines the original Pathfinding.cloud/banner change with the documentation accuracy fixes harvested from #558 (so README is owned by a single PR and won't conflict).
## NOTE: This repo/project has been restored by Salesforce.banner..mdpaths indocs/).README.md,docs/index.md,docs/user-guide/overview.md.Harvested from #558 (credit)
The documentation-accuracy portion is harvested from #558 by @nikhil6393 (co-authored on the commit). Dropped from that PR as obsolete: the
pyproject.tomluv-version hunk and the.readthedocs.ymluv pin to0.10— master already requires uv>=0.11.0, so pinning to0.10would break the docs build. Thecli.pydocstring change from #558 is applied on the feature branch (#593) instead, since that PR ownscli.py.Known follow-up (out of scope here)
docs/report/triage.mdis a full page still documenting the (removed) triage CSV worksheet, anddocs/appendices/comparison-to-other-tools.mdreferences it. Neither #558 nor this PR touches them; worth a dedicated cleanup so the docs are internally consistent.🤖 Generated with Claude Code