Skip to content

Update repository documentation#110

Merged
thomasnemer merged 2 commits intomainfrom
13-update-repository-documentation
Nov 11, 2025
Merged

Update repository documentation#110
thomasnemer merged 2 commits intomainfrom
13-update-repository-documentation

Conversation

@thomasnemer
Copy link
Copy Markdown
Contributor

Summary

Updates repository documentation to reflect the current state of the project and removes outdated references.

Fixes #13

Changes Made

README.md Updates

  • ✅ Removed ThemeParser references (doesn't exist) and updated to AdvancedTheme
  • ✅ Updated theming section to reflect actual APIs (Color, ThemeManager, AdvancedTheme)
  • ✅ Moved Roadmap to reference GitHub issues as authoritative source
  • ✅ Clarified that adapters are example implementations in examples/, not core framework
  • ✅ Fixed all code examples to use correct Scene-based architecture
  • ✅ Verified all code examples are accurate and compilable
  • ✅ Made Scene-based architecture prominent throughout

CONTRIBUTING.md (New File)

Created comprehensive contributing guide with:

  • Development environment requirements (C++20, CMake, Ninja, mise)
  • Building instructions (mise build, mise demo, manual CMake)
  • Development workflow (mise format, mise test, mise demo)
  • Code style guidelines (CRTP, header-only, relative coordinates, component architecture)
  • Testing guidelines
  • Pull request process
  • Git hooks policy with strong warnings against bypassing

Files Changed

  • README.md - 105 insertions, 74 deletions
  • CONTRIBUTING.md - 513 lines (new file)

Testing

  • All documentation changes reviewed for accuracy
  • Code examples verified against actual codebase
  • No references to non-existent features
  • Clear distinction between core framework and examples

Acceptance Criteria

  • README.md has no references to non-existent features (ThemeParser)
  • README.md theming section reflects actual API (Color, ThemeManager, AdvancedTheme)
  • Roadmap moved to reference GitHub issues
  • Adapter positioning clarified (examples, not core)
  • CONTRIBUTING.md created with all sections
  • Clear mise workflow documentation
  • Code style guidelines documented
  • Git hooks policy documented (never bypass)
  • All code examples verified to be accurate

This commit addresses issue #13 by updating the repository documentation
to reflect the current state of the project and removing outdated references.

Changes to README.md:
- Remove ThemeParser references and update to AdvancedTheme
- Update theming section with actual APIs (Color, ThemeManager, AdvancedTheme)
- Move Roadmap to reference GitHub issues as authoritative source
- Clarify that adapters are example implementations, not core framework
- Fix code examples to use correct Scene-based architecture
- Verify all code examples are accurate and compilable
- Emphasize Scene as the root of the UI hierarchy

New CONTRIBUTING.md:
- Document development environment requirements (C++20, CMake, Ninja, mise)
- Document building with mise and manual CMake commands
- Document development workflow (mise format, test, demo)
- Document code style guidelines (CRTP, header-only, relative coordinates)
- Document pull request process
- Emphasize NEVER bypassing git hooks, iwyu, or clang-format

All documentation now accurately reflects the actual codebase structure
and provides clear guidance for contributors.
- Correctly identify that project uses hk (https://github.com/jdx/hk)
- Remove mention of non-existent commit-msg hook
- Remove mention of iwyu in pre-commit hook (only clang-format runs)
- Document that hk.pkl defines the hook configuration
- Update installation instructions to use 'hk install'
- Clarify that only C++ files are checked by the hook
@thomasnemer thomasnemer merged commit f3a979c into main Nov 11, 2025
1 check passed
@thomasnemer thomasnemer deleted the 13-update-repository-documentation branch November 11, 2025 08:50
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.

Update repository documentation

1 participant