docs(rules): add onboarding index (000-index.md) generation rules (#463) - #966
Open
dheerajsingh544 wants to merge 1 commit into
Open
dheerajsingh544 wants to merge 1 commit into
dheerajsingh544 wants to merge 1 commit into
Conversation
…slabs#463) New contributors (and returning ones) have no way to tell where to start among the many documentation files AI-DLC generates across stages and phases. - Add common/onboarding-index.md: defines when to create/update 000-index.md files at three levels (stage-artifact folder, phase folder, root aidlc-docs/), the index content format for each level (file list vs. subfolder list), and description/ordering rules. Reading order is chronological (workflow execution order), not alphabetical, and lives in the index rather than in renamed filenames, so existing artifact naming is untouched. - Wire it into core-workflow.md: load the new rule file alongside the other common rules, add a MANDATORY: Onboarding Index Maintenance section enforced the same way Content Validation already is (once, globally, before stage completion, rather than repeated per stage file), and reflect the new 000-index.md files in the Directory Structure diagram. Closes awslabs#463. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
dheerajsingh544
requested review from
a team,
Kalindi-Dev,
apackeer,
harmjeff,
leandrodamascena,
raj-jain-dev,
scottschreckengaust and
spraja08
August 28, 2026 07:00
This branch has not been deployed
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.
Checklist
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.