Skip to content

Update README to reflect current module structure#49

Merged
cfuehrmann merged 1 commit intomainfrom
docs/update-readme-module-structure
Oct 6, 2025
Merged

Update README to reflect current module structure#49
cfuehrmann merged 1 commit intomainfrom
docs/update-readme-module-structure

Conversation

@cfuehrmann
Copy link
Owner

Summary

Updates README documentation to accurately reflect the current module/folder structure after recent refactoring.

Changes

  • Fix directory reference: schema/jsonc/ (reflects actual directory structure)
  • Update module descriptions: Better describe jsonc module functionality
  • Add missing modules: Document discovery.rs and mod.rs in catalog
  • Reflect recent changes: Account for storage→jsonc rename and error architecture consolidation

Context

Recent refactoring renamed the storage module to jsonc and moved discovery functionality, but the README still referenced the old structure. This brings the documentation in line with the actual codebase.

No functional changes - documentation only.

- Fix schema/ -> jsonc/ directory reference
- Update catalog module descriptions to match current structure
- Reflect recent refactoring from storage to jsonc naming
- Add discovery.rs and mod.rs documentation
@cfuehrmann cfuehrmann merged commit ec692bf into main Oct 6, 2025
5 checks passed
@cfuehrmann cfuehrmann deleted the docs/update-readme-module-structure branch October 6, 2025 12:14
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.

1 participant