Skip to content

docs: Update documentation to reflect current features #178#558

Closed
nikhil6393 wants to merge 3 commits into
salesforce:masterfrom
nikhil6393:update-documentation
Closed

docs: Update documentation to reflect current features #178#558
nikhil6393 wants to merge 3 commits into
salesforce:masterfrom
nikhil6393:update-documentation

Conversation

@nikhil6393

Copy link
Copy Markdown
Contributor

Resolves #178
This pull request removes mentions of 'triage worksheet' which is no longer generated. It also mentions that Cloudsplaining can scan across multiple AWS accounts, adds Credentials Exposure to the list of risks, and adds ReadTheDocs glossary links for the risk definitions.

kmcquade added a commit that referenced this pull request Jun 14, 2026
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 added a commit that referenced this pull request Jun 14, 2026
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>
@kmcquade

Copy link
Copy Markdown
Collaborator

Thanks for this, @nikhil6393! 🙏 The documentation accuracy fixes are valuable, so I've harvested them into #595 (co-authored on the commits, so your credit is preserved):

  • README + docs/index.md + docs/user-guide/overview.md: removed the "triage worksheet" wording, added multi-account scanning, added Credentials Exposure, and the glossary links.
  • The cli.py docstring trim is included there too.

Two hunks were dropped as obsolete: the pyproject.toml uv-version change and the .readthedocs.yml pin to 0.10 — master now requires uv >=0.11.0, so pinning to 0.10 would actually break the docs build (its current latest already works). Reconciled the privesc wording with the Pathfinding.cloud change.

Closing in favor of #595. Follow-up worth a separate PR: docs/report/triage.md is a whole page still describing the removed triage worksheet.

@kmcquade kmcquade closed this Jun 14, 2026
kmcquade added a commit that referenced this pull request Jun 14, 2026
…sary links; drop triage worksheet) (#595)

* docs: update privesc source to Pathfinding.cloud; drop restored-by-Salesforce 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>

* docs: modernize descriptions (harvest #558)

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>

* docs: drop "triage worksheet" from cli docstrings (harvest #558)

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>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-authored-by: nikhil6393 <nikhil900285@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update documentation to reflect current features

2 participants