Repository navigation
Pillar-first content structure and document intake - #5
Merged
Merged
Conversation
Add an index.md to each core/ folder (CPU and the four SAGA chips) stating its scope, planned files and that it has no content yet, and .gitkeep files for the other planned folders so they exist in Git. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- best-practices/ and pitfalls/ move under each pillar: core/, os/, toolchain/. CI derives the expected type from the path. - os/best-practices/ and os/pitfalls/ are allowed. Only 'works on AmigaOS, fails on ApolloOS' is excluded: that is an ApolloOS.R10 issue. - Document intake for official Apollo documents (maintainers only): the original in sources/official/ is leading, generated files carry origin: official and generated_from, CI checks maintainer ownership. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Nov 2, 2026
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.
Creates the content folder structure (Git doesn't track empty folders) and reorganizes it around the three pillars.
Pillar-first layout
core/,os/andtoolchain/each have reference files plus their ownbest-practices/andpitfalls/.guides/,examples/,conventions/andlessons/stay top-level, because their content cuts across the pillars.core/gets anindex.mdper CPU/chip folder (cpu-68080,saga-video-isabelle,saga-audio-arne,saga-dma-anni,saga-3d-maggie) with:kblib.expected_type) derives the expectedtypefrom the path:<pillar>/best-practices/→ best-practice,<pillar>/pitfalls/→ pitfall, other pillar files → reference.OS best practices and pitfalls
os/best-practices/andos/pitfalls/are allowed. Excluded: anything that works on AmigaOS but fails on ApolloOS. That's an ApolloOS bug and goes to an issue in ApolloOS.R10. Takeover entry/exit knowledge goes inos/, and hardware programming during a takeover goes incore/.Document intake (maintainers only)
CONTRIBUTING.md section 11 describes how official Apollo documents enter the knowledge base:
sources/official/(ODT preferred) and is leading: updates go through intake again, and generated files are never edited by hand.origin: official(new value), a maintainer asowner, andgenerated_from: sources/official/<file>.officialfile's owner is a maintainer (read from the*line inCODEOWNERS.base);generated_fromrequiresorigin: official, points intosources/official/, and the file exists.officialfiles as authoritative and never to edit generated files.sources/is excluded from content checks and owned by the maintainers.🤖 Generated with Claude Code