Repository navigation
docs: add folder-level README and AGENTS guides - #22
Merged
Merged
Conversation
Add README.md and AGENTS.md to every directory a contributor enters: root, .github, .github/workflows, .aii, src, src/biofirm, src/biofirm/data, tests, tools, models, Documentation, Documentation/Notebooks, Bio_Perplexity, One_Earth and Stream. The root README.md and models/README.md were already current and are unchanged. Guides record purpose, build and check commands, generated versus hand-written files, custody-critical paths and traps. Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@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.
Adds
README.mdandAGENTS.mdto every directory in the repository that a contributor or agent enters.Coverage
AGENTS.md(15): repository root,.github,.github/workflows,.aii,src,src/biofirm,src/biofirm/data,tests,tools,models,Documentation,Documentation/Notebooks,Bio_Perplexity,One_Earth,Stream.README.md(13): all of the above except the repository root andmodels/, whose existing README files were already current and are unchanged.Documentation/andsrc/contain no files besides their own guides and their subdirectories; that is stated in their guides. No directory was skipped.Content
Each guide records:
.gitleaksignore);Verification
uv run python tools/verify_repository.pypasses. It checks every relative markdown link, the nine required documents, source-data structure, notebook policy, and credential patterns.