Skip to content

Architecture documentation#13

Merged
andres-javier-lopez merged 5 commits into
mainfrom
architecture-documentation
Mar 14, 2026
Merged

Architecture documentation#13
andres-javier-lopez merged 5 commits into
mainfrom
architecture-documentation

Conversation

@andres-javier-lopez
Copy link
Copy Markdown
Member

@andres-javier-lopez andres-javier-lopez commented Mar 13, 2026

Description

Add documentation for external AI Agents or developers to easily implement the library

Type of change

  • Bugfix
  • New feature
  • Documentation update
  • Refactor
  • Chore

Checklist

Please run through the checklist and mark the items off before requesting review.

  • Tests added/updated for changes in behavior
  • Linter/formatter run (make format / make lint)
  • Documentation updated (if applicable)
  • CHANGELOG.md updated with a short entry describing the change (Required)

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds architecture and external-consumer build documentation to help downstream users understand assistant_core’s builder/context model and implement agents more consistently.

Changes:

  • Add new internal architecture guide (ARCHITECTURE.md) describing core layers (state/nodes/factories/context/builders) and build pipeline.
  • Add new external “from-scratch” agent build reference (AGENT_BUILD_REFERENCE.md) with recommended patterns (ContextFactory/BuilderContext, tool builders, entrypoint chaining).
  • Update README and CHANGELOG to point to the new documentation and reflect current module layout/extension points.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
README.md Adds links to new docs and updates project layout/extension-point guidance.
CHANGELOG.md Records the documentation additions under NEXT.
ARCHITECTURE.md New internal architecture/reference document for builders, nodes, and state flow.
AGENT_BUILD_REFERENCE.md New prescriptive guide for external library consumers to build agents with assistant_core.
.github/copilot-instructions.md Updates contributor/copilot guidance around verification after formatting/linting.

You can also share your feedback on Copilot code review. Take the survey.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread CHANGELOG.md Outdated
Comment thread ARCHITECTURE.md Outdated
Comment thread AGENT_BUILD_REFERENCE.md
andres-javier-lopez and others added 2 commits March 14, 2026 09:06
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@andres-javier-lopez andres-javier-lopez merged commit e159318 into main Mar 14, 2026
1 check passed
@andres-javier-lopez andres-javier-lopez deleted the architecture-documentation branch March 14, 2026 15:24
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.

2 participants