Skip to content

Restructure docs/site to Diataxis and cover v0.7.0 API#139

Merged
kommundsen merged 3 commits intomainfrom
chore/improved-docs
Apr 11, 2026
Merged

Restructure docs/site to Diataxis and cover v0.7.0 API#139
kommundsen merged 3 commits intomainfrom
chore/improved-docs

Conversation

@kommundsen
Copy link
Copy Markdown
Owner

Description

Reorganizes docs/site/articles/ into a strict Diataxis four-quadrant layout and adds documentation for all v0.7.0 unshipped API surface.

Structure changes:

  • Replaces the flat guides/ bucket with three purpose-built directories: how-to/, reference/, explanation/
  • Removes installation.md, getting-started.md, troubleshooting.md, configuration.md — content redistributed into the correct quadrants
  • All toc.yml files rewritten to match the new layout

New content (v0.7.0 coverage):

  • tutorials/07-data-generation.mdDataGen.Sample/SampleOne/Stream walkthrough
  • how-to/reproduce-a-failure.md, export-repros.md, use-data-gen.md, use-cli-tool.md
  • reference/strategies.md — complete Generate.* catalog
  • reference/string-strategies.mdIdentifiers, NumericStrings, VersionStrings
  • reference/extension-properties.md.Positive, .NonEmpty, | operator
  • reference/attributes.md — complete attributes reference (was missing)
  • reference/formatters.mdJsonOutputFormatter, JsonLinesOutputFormatter
  • reference/settings.md — merged settings reference including ExportReproOnFailure, ReproOutputPath
  • explanation/shrinking.md, targeted-testing.md, example-database.md, property-based-testing.md

Also adds the diataxis skill to .claude/skills/diataxis/ for future documentation work.

Type of change

  • Documentation / chore

Checklist

  • dotnet test src/ passes
  • New behavior is covered by tests (TDD: Red → Green → Refactor)
  • Follows .editorconfig code style

@kommundsen kommundsen self-assigned this Apr 11, 2026
@kommundsen kommundsen added this to the v0.7.0 milestone Apr 11, 2026
@kommundsen kommundsen merged commit d170f48 into main Apr 11, 2026
1 check passed
@kommundsen kommundsen deleted the chore/improved-docs branch April 11, 2026 10:58
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