Skip to content

Create comprehensive developer-friendly documentation for the orcpub project #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

Create comprehensive developer-friendly documentation for the orcpub project #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc19f35
Initial plan
Copilot Sep 11, 2025
c78067b
Create comprehensive developer documentation in /docs directory
Copilot Sep 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,15 @@ This is the code forked from OrcPub2, from the [original](https://github.com/lar
![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/orcpub/orcpub)
![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/orcpub/orcpub)

[About](#about) • [Getting Started](#getting-started) • [Development](#development) • [Contributing](#how-do-i-contribute?) • [Fundamentals](#Fundamentals)
[About](#about) • [Getting Started](#getting-started) • [Development](#development) • [Contributing](#how-do-i-contribute?) • [📚 Documentation](docs/index.md)

</div>

## About
Dungeon Master's Vault is a web server that allows you to host your own Character Generator website for D&D 5th Edition.

> 📚 **New to the Project?** Check out our comprehensive [Developer Documentation](docs/index.md) with beginner-friendly guides, technology overviews, and contribution instructions.


## Getting Started

Expand Down Expand Up @@ -214,6 +216,8 @@ More on these passwords here.
## How do I contribute?
Thank you for rolling for initiative!

> 📖 **Start Here**: Our new [Contributing Guide](docs/contributing.md) provides comprehensive information for contributors of all skill levels, including Clojure newcomers.

We work on forks, and branches. Fork our repo, then create a new branch for any bug or new feature that you want to work on.

### Get started
Expand Down Expand Up @@ -460,7 +464,11 @@ For this reason we have to build a dependency graph of derived attributes and th
## FAQs
**Q: I'm a newb Clojure developer looking to get my feet wet, where to start?**

**A:** *First I would start by getting the fundamentals down at https://4clojure.oxal.org/ From there you might add some unit tests or pick up an open issue on the "Issues" tab (and add unit tests with it).*
**A:** *Great question! We have comprehensive resources for Clojure newcomers:*
- *Start with our [Technology Overview](docs/technology-overview.md) to understand Clojure, ClojureScript, and the web stack*
- *Follow our detailed [Getting Started](docs/getting-started.md) guide for step-by-step setup instructions*
- *Try the interactive exercises at https://4clojure.oxal.org/ to practice Clojure fundamentals*
- *Check our [Contributing Guide](docs/contributing.md) for beginner-friendly issues and development tips*


**Q: Your DSL for defining character options is pretty cool, I can build any type of character option out there. How about I add a bunch on content from the Player's Handbook?**
Expand Down
Loading
Loading