Add developer and user documentation as GitHub Pages site#171
Open
matthewwachter wants to merge 3 commits into
Open
Add developer and user documentation as GitHub Pages site#171matthewwachter wants to merge 3 commits into
matthewwachter wants to merge 3 commits into
Conversation
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. |
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Test plan: