Skip to content

Move game spec and cards to separate meta repository#32

Merged
shenanigansd merged 2 commits into
mainfrom
claude/gallant-rubin-qMdKT
May 31, 2026
Merged

Move game spec and cards to separate meta repository#32
shenanigansd merged 2 commits into
mainfrom
claude/gallant-rubin-qMdKT

Conversation

@shenanigansd
Copy link
Copy Markdown
Member

This PR reorganizes documentation by moving the game specification and card catalog to a separate meta/spec repository (mundane), while updating all references in the backend repository accordingly.

Summary

The game rules (SPEC.md) and card catalog (CARDS.md) have been moved out of the backend repository into a dedicated meta/spec repository. The backend now references these documents from their new location, and documentation has been updated to clarify the separation between the rules specification and the implementation.

Key Changes

  • Removed game documentation files: Deleted game-docs/SPEC.md and game-docs/CARDS.md from the backend repository
  • Updated documentation site (docs/index.rst):
    • Expanded the introduction to clarify the architecture (engine and API)
    • Added a note directing readers to the spec repository for rules and cards
    • Reorganized content with Architecture and API reference sections
    • Added a table documenting the HTTP API endpoints
  • Updated README.md: Changed links to point to the spec documents in the mundane meta repository instead of local files
  • Updated changelog (docs/changelog.rst): Added initial feature entries documenting the engine and API
  • Fixed syntax error in docs/conf.py: Changed except OSError, TypeError: to except (OSError, TypeError):
  • Updated repository URL in pyproject.toml: Changed from mundane/ to mundane-backend to reflect the split

Rationale

This separation allows the game specification to be maintained independently from the implementation, making it easier for multiple implementations (in different languages/frameworks) to reference the same authoritative rules and card definitions.

https://claude.ai/code/session_01KtjeZXxEzk51k5dWs3rxpe

The game spec and card catalog now live in the letsbuilda/mundane
meta/spec repo, so remove game-docs/ here and point the README at the
new location.

Flesh out the Sphinx docs with backend-specific content (engine + API
architecture and an endpoint table) and fix two issues the docs depend
on:

- conf.py: `except OSError, TypeError:` is invalid Python 3 syntax and
  broke the Sphinx build outright; parenthesize the exception tuple.
- pyproject.toml: point `repository` at mundane-backend so autoapi's
  "view source" (linkcode) and the releases changelog links resolve to
  the repo that actually holds the source.

https://claude.ai/code/session_01KtjeZXxEzk51k5dWs3rxpe
Comment thread docs/conf.py Fixed
Signed-off-by: Bradley Reynolds <bradley.reynolds@tailstory.dev>
@shenanigansd shenanigansd merged commit 86b573f into main May 31, 2026
12 checks passed
@shenanigansd shenanigansd deleted the claude/gallant-rubin-qMdKT branch May 31, 2026 17:44
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.

2 participants