Skip to content

docs: Add ARCHITECTURE.md and update AGENTS.md for AI context#106

Merged
erseco merged 1 commit intomainfrom
jules-401451429682461264-e1ed454d
Mar 2, 2026
Merged

docs: Add ARCHITECTURE.md and update AGENTS.md for AI context#106
erseco merged 1 commit intomainfrom
jules-401451429682461264-e1ed454d

Conversation

@erseco
Copy link
Copy Markdown
Collaborator

@erseco erseco commented Mar 2, 2026

This PR introduces architectural documentation to better guide both AI agents and human developers working on the Documentate plugin.

Changes Included:

  1. Added ARCHITECTURE.md: A high-level document that covers:
    • The primary components: documentate_document CPT and documentate_doc_type taxonomy.
    • The Document Generation flow using OpenTBS and .odt templates.
    • The Document Conversion flow (Collabora Online vs. WASM ZetaJS).
    • Access Control and Scope logic (filtering by user scope categories).
    • Potential areas of improvement and notes on the REST API protection granularity.
  2. Updated AGENTS.md: Added a directive instructing AI agents to review ARCHITECTURE.md before attempting any major modifications to ensure architectural consistency.

PR created automatically by Jules for task 401451429682461264 started by @erseco

@google-labs-jules
Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

Adds a high-level overview of the Documentate plugin architecture,
data flow (OpenTBS, CPTs, Conversion Managers), and access control
mechanisms to assist AI agents and new developers. Updates AGENTS.md
to require reading ARCHITECTURE.md before major changes.

Co-authored-by: erseco <1876752+erseco@users.noreply.github.com>
@erseco erseco force-pushed the jules-401451429682461264-e1ed454d branch from 3574685 to 074792c Compare March 2, 2026 10:16
@erseco erseco merged commit abeb7fa into main Mar 2, 2026
4 checks passed
@erseco erseco deleted the jules-401451429682461264-e1ed454d branch March 2, 2026 10:17
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