Skip to content

docs: add code quality and CI conventions to SDK docs (phase 2)#15

Merged
TheRealAgentK merged 1 commit intomasterfrom
docs/unify-integration-docs-phase2
Mar 16, 2026
Merged

docs: add code quality and CI conventions to SDK docs (phase 2)#15
TheRealAgentK merged 1 commit intomasterfrom
docs/unify-integration-docs-phase2

Conversation

@TheRealAgentK
Copy link
Copy Markdown
Collaborator

Companion to the tooling repo Phase 2 PR. Adds content to SDK docs that was previously only in the tooling repo's checklist.

Changes

docs/manual/patterns.md (+71 lines)

  • Code Quality Conventions: constants at module level, type hints, never hardcode credentials
  • Linting and CI: ruff rules (E/F/W), per-file suppressions table, # noqa guidance, bandit config (B101 skipped), common bandit flags, pip-audit

docs/manual/building_your_first_integration.md (+11 lines)

  • Platform OAuth test example showing wrapped auth structure alongside flat custom auth example

Related

@TheRealAgentK TheRealAgentK marked this pull request as ready for review March 16, 2026 01:34
@TheRealAgentK
Copy link
Copy Markdown
Collaborator Author

@Hamish-taylor @Shubhank-Jonnada @ProRedCat

This PR is essentially additions to the new SDK documentation we added in Phase 1 that came out of the cleanup of the tooling repo (which now had a lot of duplication).

@Shubhank-Jonnada
Copy link
Copy Markdown

lgtm!

@TheRealAgentK TheRealAgentK merged commit 8f27fdd into master Mar 16, 2026
@TheRealAgentK TheRealAgentK deleted the docs/unify-integration-docs-phase2 branch March 16, 2026 02:25
@TheRealAgentK TheRealAgentK mentioned this pull request Mar 30, 2026
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants