Skip to content

docs: add reading order for the security model to GETTING_STARTED.md - #156

Open
AaliyaKhan25 wants to merge 2 commits into
UnplugAI:devfrom
AaliyaKhan25:docs-security-order
Open

docs: add reading order for the security model to GETTING_STARTED.md#156
AaliyaKhan25 wants to merge 2 commits into
UnplugAI:devfrom
AaliyaKhan25:docs-security-order

Conversation

@AaliyaKhan25

Copy link
Copy Markdown
Contributor

Summary

Checklist

  • The issue this closes was assigned to me (see CONTRIBUTING.md)
  • This is my only open PR (one issue at a time, see CONTRIBUTING.md)
  • Target branch is dev (see BRANCHING.md)
  • cd sdk && make check-ci passes locally
  • New code has tests (every module gets a test file)
  • Public API changes are reflected in sdk/README.md / sdk/docs/
  • No secrets, internal URLs, or private paths in the diff
  • If a model wrote a meaningful part of this, I said so below (AI_POLICY.md)

Notes for reviewers

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 23, 2026
@greptile-apps

greptile-apps Bot commented Aug 23, 2026

Copy link
Copy Markdown

Greptile Summary

Adds an ordered security-model reading guide to the getting-started documentation.

  • Separates security-model resources from the general next-steps table.
  • Guides readers from architecture and enforcement concepts through agent, RAG, and public API documentation.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
sdk/docs/GETTING_STARTED.md Adds a coherent security-model reading sequence using repository-relative documentation links.

Reviews (3): Last reviewed commit: "docs: restore integrations/deployment ta..." | Re-trigger Greptile

@chiruu12 chiruu12 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ordering is right and all six targets resolve.

It drops four links though. integrations/custom-loop/README.md, integrations/README.md, sdk/README.md and DEPLOYMENT.md appeared only in the table you replaced, so after this the getting-started page has no route to the integrations or to deployment at all.

Keep them, in a second short table under the new one.

@AaliyaKhan25

Copy link
Copy Markdown
Contributor Author

Fixed — restored the integrations/deployment table separately, kept the security-model table below it as its own table.

@AaliyaKhan25
AaliyaKhan25 requested a review from chiruu12 August 24, 2026 16:15
@AaliyaKhan25
AaliyaKhan25 marked this pull request as draft August 26, 2026 10:09
@AaliyaKhan25
AaliyaKhan25 marked this pull request as ready for review August 26, 2026 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants