Skip to content

Feature/repo maintenance - #106

Open
ahjephson wants to merge 4 commits into
developfrom
feature/repo-maintenance
Open

Feature/repo maintenance#106
ahjephson wants to merge 4 commits into
developfrom
feature/repo-maintenance

Conversation

@ahjephson

@ahjephson ahjephson commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Summary

Introduce a repo-side GitHub governance baseline and a publishable documentation site, while restructuring the README and support content so installation, deployment, and contribution guidance are clearer and easier to maintain.

What Changed

  • Added GitHub issue forms for bugs, feature proposals, UX improvements, performance regressions, and documentation or deployment gaps, plus issue-template routing to Discussions where work is not yet actionable.
  • Added repo-managed governance assets for issue triage, label definitions, and the intended roadmap project field and view model.
  • Added GitHub tooling documentation and a tools/github/sync-labels.sh helper to create or update the managed label set from .github/labels.json.
  • Added an MkDocs documentation site under docs/, including installation, advanced setup, reverse proxy hosting, separate API and UI hosting, and build-from-source guides.
  • Added a GitHub Pages workflow to build the docs site on documentation changes and deploy it from develop.
  • Reworked README.md to focus on overview, quick start, docs entry points, and contribution routing, and added dedicated CONTRIBUTING.md and SUPPORT.md guidance.
  • Moved the README screenshot assets into the MkDocs content tree and updated the screenshot capture tooling to write to the new location.
  • Updated .gitignore for local docs tooling and generated site output.

Testing

  • No application test coverage was added because this branch is limited to repository governance, documentation, and tooling changes.
  • Added CI validation for documentation changes through the new strict MkDocs build workflow on pull requests, with GitHub Pages deployment on develop pushes.
  • Reviewed the new documentation and governance assets for consistency with the existing deployment configuration model and repository contribution flow.

Notes

  • This branch does not change qbtmud runtime behaviour or the shipped application code.
  • The roadmap project definition is stored in the repository, but applying or updating project fields still requires a GitHub token with project scopes.

@ahjephson
ahjephson marked this pull request as ready for review June 19, 2026 21:08

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b6cd86a74a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/content/reverse-proxy.md Outdated

sub_filter_types text/html;
sub_filter_once off;
sub_filter '<base href="/">' '<base href="/qbtmud/">';

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Match the shipped base tag in proxy rewrites

For subpath reverse-proxy setups, these rewrite rules won't match the actual entry point: src/Lantean.QBTMud/wwwroot/index.html currently emits <base href="/" />, but the examples search for <base href="/">. Following the guide leaves the base tag unchanged, so qbtmud still resolves assets and routes from /; adjust the match or regex to handle the self-closing form with whitespace.

Useful? React with 👍 / 👎.

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