docs(docs): add Help subfolder with 15 technical reference guides - #148
Merged
Conversation
… entry point Add comprehensive documentation structure with token optimization support: - Create Docs/Help/ subfolder with 15 technical reference files: - commit-reference.md, commit-scopes.md (commit workflow) - coding-rules.md, function-index.md, testing-strategy.md (code development) - architecture-quick-ref.md, config-schema.md, templates-guide.md (architecture) - features-overview.md, receipt-format.md (functionality) - workflow.md, github-workflows.md, slash-commands-reference.md (processes) - debugging.md, glossary.md (reference) - Create Docs/Help/README.md: unified index with context optimization guide - Task-to-file mapping (17 common tasks) - Reference relationship diagram - Token usage analysis (40-60% savings per conversation) - Navigation paths for workflows - Create Docs/README.md: main entry point with quick navigation Benefits: - Focused, task-specific documentation modules - Reduces token usage by loading only relevant files - Reference relationships help users navigate efficiently
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.
Summary
Adds a
Docs/Help/subfolder containing 15 technical reference guides covering key areas of the codebase (coding rules, architecture, functions, Excel COM patterns, configuration, testing, CI/CD, versioning, and more), plus an entry-point index.Changes
Docs/Help/— new subfolder with 16 files (15 guides +README.mdindex)Checklist
Invoke-Pester Tests/ -Output Detailedpasses with no failures.ps1files.ps1filesCHANGELOG.mdupdated (if user-facing change)