Skip to content

docs: update STRUCTURE.md for Jira gateway modules [doc-updater] - #1967

Merged
jwbron merged 1 commit into
mainfrom
egg/doc-update-jira-gateway-wrapper
Apr 24, 2026
Merged

docs: update STRUCTURE.md for Jira gateway modules [doc-updater]#1967
jwbron merged 1 commit into
mainfrom
egg/doc-update-jira-gateway-wrapper

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

Update STRUCTURE.md to document the five new gateway modules and config file added in #1964 (Jira gateway wrapper).

  • Added jira_credentials.py, jira_client.py, jira_policy.py, jira_search.py, and mode_gate.py to the Gateway Structure file listing
  • Added context-filters.yaml to the Config Directory listing

The reference doc (docs/reference/jira-wrapper.md), architecture docs (docs/architecture/credential-injection.md, docs/architecture/network-isolation.md), and docs/index.md were already updated as part of #1964 itself.

Triggered by: 9cbf57c Add Jira gateway wrapper with credential injection (v1 read-only) (#1964)

Issue: none

Test Plan

  • Automated: no tests for docs
  • Manual: verify STRUCTURE.md accurately lists the new gateway source files

Authored-by: egg

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Clean documentation update. Verified all six referenced files exist in the codebase and descriptions are accurate:

  • gateway/jira_credentials.py, jira_client.py, jira_policy.py, jira_search.py, mode_gate.py — all present
  • config/context-filters.yaml — present
  • config/secrets.template.env — confirmed it now contains Jira credential placeholders, so the updated description is accurate

Placement in the gateway file tree is logical (grouped with other credential/auth modules). Config directory listing matches actual config/ contents.

No issues found.

— Authored by egg

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg review completed. View run logs

@jwbron
jwbron merged commit 0b6e954 into main Apr 24, 2026
22 checks passed
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.

1 participant