Skip to content

docs(docs): add Help subfolder with 15 technical reference guides - #148

Merged
ndomako10 merged 1 commit into
masterfrom
docs/add-help-subfolder
Mar 25, 2026
Merged

docs(docs): add Help subfolder with 15 technical reference guides#148
ndomako10 merged 1 commit into
masterfrom
docs/add-help-subfolder

Conversation

@ndomako10

Copy link
Copy Markdown
Owner

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.md index)

Checklist

  • Invoke-Pester Tests/ -Output Detailed passes with no failures
  • PSScriptAnalyzer reports no Error or Warning violations on changed .ps1 files
  • No non-ASCII characters in changed .ps1 files
  • Commit messages follow Conventional Commits format
  • CHANGELOG.md updated (if user-facing change)
  • Documentation updated (README, CONTRIBUTING, or CLAUDE.md as applicable)

… 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
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Mar 25, 2026
@ndomako10
ndomako10 merged commit 7e4d6fc into master Mar 25, 2026
3 checks passed
@ndomako10
ndomako10 deleted the docs/add-help-subfolder branch March 25, 2026 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants