docs: add files for ai tools#1868
Open
janfb wants to merge 3 commits into
Open
Conversation
AGENTS.md is the tool-agnostic entry point for AI coding agents with environment setup, testing, code style, repo structure, and an explicit no-prescribed-workflow for agent tooling. ARCHITECTURE.md is sbi's domain glossary (trainer hierarchy, posterior types, design patterns, key APIs) — useful as both human documentation and an agent-discoverable vocabulary reference.
- Update 19_flowmatching_and_scorematching link to vector_field_methods - Add how-to entries for 24_abstraction_levels and 25_choosing_vector_field_options - Serve docs/llms.txt at the docs URL root via Sphinx html_extra_path - Cross-reference llms.txt from AGENTS.md
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1868 +/- ##
=======================================
Coverage 87.89% 87.89%
=======================================
Files 143 143
Lines 13353 13353
=======================================
Hits 11736 11736
Misses 1617 1617
Flags with carried forward coverage won't be shown. Click here to find out more. |
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
1 participant
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.
this adds a general AGENTS.md and an architecture overview file for coding agents.
additionally, the
llms.txtwill help agents navigate our docs website more naturally.This is based on my common patterns of using agents, @dgedon and others, please feel free to challenge or add things.