Skip to content

Conversation

@yarikoptic-gitmate
Copy link
Collaborator

Reorganizes testing and contributing documentation into Sphinx for better searchability and navigation, and establishes file placement guidelines to prevent project root clutter.

Changes

  • New Sphinx documentation: Created docs/source/development/ with testing and contributing guides
  • Testing guide: Comprehensive guide with Quick Reference, Test Organization, Docker Setup, and examples
  • Contributing guide: Workflow guide for contributors
  • File placement guidelines: Updated CLAUDE.md with clear rules for temporary files
  • Integration: Linked new docs into main Sphinx documentation index
  • Cleanup prevention: Added .lad/tmp/ to .gitignore for LAD session artifacts

Files Changed

  • New: docs/source/development/{index,testing,contributing}.rst
  • Updated: CLAUDE.md, DEVELOPMENT.md, .gitignore, docs/source/index.rst

Benefits

  • Better documentation organization and discoverability
  • Prevents temporary analysis files from cluttering project root
  • Clearer guidelines for development workflows

Testing

Documentation only. Verified Sphinx can build without errors.

See commit: e8ed5d10

Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com

- Add comprehensive testing guide to Sphinx docs (docs/source/development/testing.rst)
- Add contributing guide to Sphinx docs (docs/source/development/contributing.rst)
- Update CLAUDE.md with file placement guidelines to prevent root clutter
- Update DEVELOPMENT.md to reference new Sphinx documentation
- Add .lad/tmp/ to .gitignore for LAD session artifacts
- Integrate development docs into main Sphinx documentation index

This improves documentation organization and prevents temporary files
from cluttering the project root. LAD-generated analysis files now go
to .lad/tmp/, while permanent documentation goes to docs/source/.

Testing documentation now properly integrated with Sphinx for better
searchability and navigation.
@yarikoptic-gitmate yarikoptic-gitmate added the documentation Changes only affect the documentation label Feb 12, 2026
@codecov
Copy link

codecov bot commented Feb 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.10%. Comparing base (a3dd9f9) to head (5c36553).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1786      +/-   ##
==========================================
- Coverage   75.11%   75.10%   -0.01%     
==========================================
  Files          84       84              
  Lines       11921    11921              
==========================================
- Hits         8954     8953       -1     
- Misses       2967     2968       +1     
Flag Coverage Δ
unittests 75.10% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Changes only affect the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants