Skip to content

docs: migrate guides to wiki and slim README#27

Merged
ngan merged 1 commit intomainfrom
np-docs-wiki-migration
Feb 24, 2026
Merged

docs: migrate guides to wiki and slim README#27
ngan merged 1 commit intomainfrom
np-docs-wiki-migration

Conversation

@ngan
Copy link
Collaborator

@ngan ngan commented Feb 24, 2026

Summary

This migrates FixtureKit documentation to the GitHub Wiki and keeps the repository README focused on quick start onboarding.

What changed

  • Rewrote README.md as quick start only.
  • Added canonical API/reference doc at docs/reference.md.
  • Published task-based wiki pages + sidebar navigation.

Wiki

Wiki page index

  1. Home
  2. Getting Started
  3. Declaring Fixtures
  4. Using Fixtures in RSpec
  5. Using Fixtures in Minitest
  6. Configuration and Adapters
  7. Cache Lifecycle and Performance
  8. Callback Hooks
  9. Anonymous Fixtures and Identifiers
  10. Multi-Database Behavior
  11. Troubleshooting

Notes for reviewers

  • No runtime code changes.
  • Existing deep README anchor links are intentionally not preserved.
  • API-level signatures/defaults are now canonical in docs/reference.md; wiki pages link to this reference for exact contracts.

@ngan ngan merged commit 1a9d7cb into main Feb 24, 2026
10 checks passed
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