Skip to content

docs: rewrite documentation for CDL v1.3#8

Merged
Bissbert merged 1 commit intomainfrom
feature/cdl-v1.3
Feb 15, 2026
Merged

docs: rewrite documentation for CDL v1.3#8
Bissbert merged 1 commit intomainfrom
feature/cdl-v1.3

Conversation

@Bissbert
Copy link
Contributor

Summary

  • Rewrite all 10 documentation pages to accurately reflect CDL v1.3 syntax, current API surfaces, and correct package names/versions
  • Fix incorrect function names, import paths, and outdated examples throughout
  • Add documentation for new v1.3 features: phenomena, feature annotations, doc comments, grouping, labels, and named references

Changed pages

Page Scope of changes
cdl.astro Major rewrite - full v1.3 spec with all new syntax features
cdl-examples.astro Major rewrite - updated examples gallery
installation.astro Fixed package names and versions
quickstart.astro Fixed API function names and imports
cli.astro Restructured for all 3 CLIs (cdl, mineral-db, cdl-lsp)
cli-options.astro Full rewrite with actual CLI flags
api/cdl-parser.astro Major rewrite - correct types, v1.3 models
api/crystal-geometry.astro Major rewrite - actual geometry API
api/mineral-database.astro Major rewrite - synthetic/simulant queries
api/crystal-renderer.astro Major rewrite - actual renderer API

Test plan

  • Run npm run build to verify all pages build without errors
  • Spot-check code examples in CDL spec page render correctly
  • Verify API documentation matches current package interfaces

Comprehensive rewrite of all 10 documentation pages to reflect
the current state of the codebase and CDL v1.3 syntax:

- cdl.astro: Full CDL specification with v1.3 features (phenomena,
  feature annotations, doc comments, grouping, labels, references)
- cdl-examples.astro: Updated examples gallery with correct syntax
- installation.astro: Corrected package names and version numbers
- quickstart.astro: Fixed API function names and import paths
- cli.astro: Restructured for all 3 CLIs (cdl, mineral-db, cdl-lsp)
- cli-options.astro: Full rewrite with actual CLI flags and options
- api/cdl-parser.astro: Correct types and new v1.3 model classes
- api/crystal-geometry.astro: Actual geometry API documentation
- api/mineral-database.astro: Synthetic/simulant query documentation
- api/crystal-renderer.astro: Actual renderer API documentation

Refs: CDL v1.3 documentation audit
@github-actions
Copy link

🚀 Preview deployed to: https://3e77d05e.gemmology-dev.pages.dev

@Bissbert Bissbert merged commit a852d10 into main Feb 15, 2026
3 of 4 checks passed
@Bissbert Bissbert deleted the feature/cdl-v1.3 branch February 15, 2026 06:34
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