📝 simplify package and generator documentation

[igotinfected]

Make the package choices and examples easier to find, and explain the generated behaviour consumers need to know.

Changes

Reworked the root and package READMEs, using the badge conventions from Blazor.Map and Blazor.RichTextEditor. Removed repeated material and added the new schema versions.

Documented choice diagnostics, scalar default presence, object-default behaviour, fixed-value inclusion, and the limits of static validation. Updated repository guidance to match the SDK and model projects.

Validation

The package examples compiled and produced XML. Checked local links and compared the documented defaults and package tables with the project configuration.

Transmodel stack, bottom to top: #68 → #69 → #70 → #71 → #72. Generator prerequisite: XmlSchemaClassGenerator #1.

This PR was generated with gpt-6-astra in Codex via T3 Code.

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Organization UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: e7ed692b-3f80-404c-88c2-60374b9baf30

📥 Commits

Reviewing files that changed from the base of the PR and between a242515 and 08f57f6.

📒 Files selected for processing (6)

• AGENTS.md
• README.md
• docs/model-behaviour.md
• src/generator/Spillgebees.Transmodel.Generator/README.md
• src/netex/Spillgebees.NeTEx.Models/README.md
• src/siri/Spillgebees.SIRI.Models/README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The README files now document versioned NeTEx and SIRI packages, custom model generation, and build steps. A new guide describes generated-model serialization behavior and analyzer limits. Project documentation also updates the listed schema versions and .NET SDK pin.

Changes

Model Package Documentation

Layer / File(s)	Summary
Package installation and usage README.md, src/netex/Spillgebees.NeTEx.Models/README.md, src/siri/Spillgebees.SIRI.Models/README.md	Adds package version tables and installation guidance. Updates serialization examples, namespace information, and links to model behavior details.
Generation and build guidance AGENTS.md, README.md, src/generator/Spillgebees.Transmodel.Generator/README.md, src/netex/Spillgebees.NeTEx.Models/README.md	Updates schema sources and generation defaults, cache details, CLI guidance, and build instructions. Documents generated-file handling, project structure, and the .NET SDK pin.
Generated-model behavior docs/model-behaviour.md	Documents analyzer diagnostics, choice groups, scalar default-value presence, fixed values, token-list serialization, and analyzer coverage limits.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~12 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 08f57

No actionable merge-blocking issue is established in this documentation update; the package, generation, build, and serialization guidance is supported by the supplied project and test evidence.

Architecture Summary

Architecture risk: 🔵 Low · up to 08f57

The change affects 4 systems.

Changed systems: src, AGENTS.md, docs, README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

• observed — src (service) was modified; 3 changed files map to changed impact.
• observed — AGENTS.md (service) was modified; 1 changed file maps to changed impact.
• observed — docs (service) was modified; 1 changed file maps to changed impact.
• observed — README.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

• observed — Modified behavior in AGENTS.md: The project structure adds SIRI v2.2.1 and v2.3 entries. It replaces the NeTEx version-specific bindings description, which specified five versions, with a wildcard project entry that does not state a version count.
• observed — Modified behavior in AGENTS.md: The documented .NET 10 SDK pin changes from 10.0.102 with roll-forward within the feature band to 10.0.401 with roll-forward to a later feature band.
• observed — Modified behavior in README.md: Replaces the centered workflow/license badges and broad project description with build, package, and license badges; a concise description of generated NeTEx and SIRI XML bindings targeting .NET 10.0; and a pre-production notice.
• observed — Modified behavior in README.md: Replaces the generator-tool introduction and installation instructions with versioned model-package installation guidance. It explains that package suffixes identify upstream schema versions, namespaces are version-specific, and meta-packages include the listed versions.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title describes simplifying package and generator documentation, which is a central part of the changes. The memo emoji adds minor noise but does not make the title unclear.
Description check	✅ Passed	The description covers the documentation changes, added schema versions, generated-model behavior, and reported validation. It is directly related to the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{A rabbit reads the version rows,
Then hops where XML’s pathway goes.
New notes describe each choice and tag,
While schema versions fill the bag.
The bunny thumps: “The docs now flow!”}

_{Comment @coderabbitai help to get the list of available commands.}