Architecture documentation#13
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
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.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add documentation for external AI Agents or developers to easily implement the library
Type of change
Checklist
Please run through the checklist and mark the items off before requesting review.