Skip to content

Add developer and user documentation as GitHub Pages site#171

Open
matthewwachter wants to merge 3 commits into
thomaswp:devfrom
matthewwachter:docs/github-pages
Open

Add developer and user documentation as GitHub Pages site#171
matthewwachter wants to merge 3 commits into
thomaswp:devfrom
matthewwachter:docs/github-pages

Conversation

@matthewwachter

Copy link
Copy Markdown

It took me quite a while to get up to speed on the project so I thought it would be helpful for everyone here to have developer documentation. I prefer github pages over wiki format as it is easier to track changes and make updates on the fly.

Yes, I absolutely used AI agents to help generate this but worked from a template I've been using across many projects. I checked for accuracy to the best of my abilities but ideally someone more familiar with the codebase could verify. At the very least, it contains full coverage for all existing documentation. That being said, given the use of AI tools to generate this, I won't be offended if my PR is denied.

You can see it working on my fork: matthewwachter.github.io/BeaverBuddies

Features:

  • Adds a Docsify-based documentation site in docs/ with 14 pages covering the full codebase
  • Includes player-facing guides (installation, port forwarding, troubleshooting, FAQ) migrated from the wiki
  • Includes developer guides (architecture, event system, networking, tick sync, determinism, connection flow, multiplayer maps, configuration, testing, contributing, etc.)

Test plan:

  • - Preview locally with docsify serve docs or python -m http.server in docs/
  • - Verify all sidebar links resolve
  • - Check developer documentation for accuracy
  • - Verify C# code blocks have syntax highlighting
  • - Enable GitHub Pages from the docs/ folder in repo settings

@thomaswp

thomaswp commented May 2, 2026

Copy link
Copy Markdown
Owner

Hey, sorry for the late reply. This is a good idea, and @robinplace has already suggested moving the wiki to files to enable PRs. It's also a lot of content to review (but also not critical if something wrong slips by). So I'll work on it.

Now that you're more up to speed, happy to review any PRs. There are a few good first-timer issues if you want to tackle them.

@thomaswp

thomaswp commented May 2, 2026

Copy link
Copy Markdown
Owner

My other thought is that this is also a lot of information for a potential contributor to get into. And also to keep up-to-date as things change. But skimming, most of it is a nice summary. Just musing out loud, wondering what the right balance of brevity and summary to detail is. And if it's dev-oriented, I could imagine a cleaner set of entrypoints for common contributions.

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