Skip to content

Reorganize documentation structure with improved categorization#696

Merged
jamespepper81 merged 1 commit into
devfrom
claude/affectionate-lovelace-HBrBY
May 27, 2026
Merged

Reorganize documentation structure with improved categorization#696
jamespepper81 merged 1 commit into
devfrom
claude/affectionate-lovelace-HBrBY

Conversation

@jamespepper81
Copy link
Copy Markdown
Contributor

Summary

Reorganized the documentation README to improve discoverability and maintainability by grouping related documents into logical categories. Added new documentation files for tax features, performance optimization, architecture design, and testing. Also added a "Community & Support" section to the main README with links to discussions, issue templates, and security reporting.

Type of Change

  • Documentation update

Changes

docs/README.md

  • Reorganized structure from flat list to categorized sections:
    • Product & Planning
    • Setup & Configuration
    • Performance
    • Architecture & Design
    • Fix & Implementation Summaries
    • Testing
    • Marketing & SEO
    • Archive
  • Added new documentation references:
    • Tax features: TAX_FAQ.md, TAX_REPORTING_GUIDE.md, ACCOUNTING_METHODS.md
    • Setup: dependabot-configuration.md, BITCOIN_DEPENDENCY_UPDATES.md, RULES_FILE_DOCUMENTATION.md
    • Performance: 7 new performance-related docs
    • Architecture: 5 new design and architecture docs
    • Testing: TESTING_GUIDE.md
  • Improved formatting: Changed dashes to em-dashes for consistency
  • Updated guidelines: Clarified file naming conventions (kebab-case) and contribution process
  • Added archive section for older documentation

README.md

  • Added "Community & Support" section with:
    • Link to GitHub Discussions
    • Bug report template link
    • Feature request template link
    • Security reporting instructions

Test Plan

N/A — Documentation-only changes. Links and structure can be verified by reviewing the rendered markdown.

Checklist

  • Documentation updated

https://claude.ai/code/session_011fm7oYezFg8PxYWA74oRnb

Link GitHub Discussions, issue templates, and security contact in a new
README section. Rewrite docs/README.md to catalog all 35+ documentation
files organized by category.

https://claude.ai/code/session_011fm7oYezFg8PxYWA74oRnb
@jamespepper81 jamespepper81 merged commit 11cdf7e into dev May 27, 2026
4 checks passed
@jamespepper81 jamespepper81 deleted the claude/affectionate-lovelace-HBrBY branch May 27, 2026 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants