Create comprehensive developer-friendly documentation for the orcpub project

[Copilot]

This PR addresses the need for high-quality, developer-friendly documentation by creating a dedicated /docs directory with comprehensive guides that are especially welcoming to developers new to the Clojure ecosystem.

What's Added

New Documentation Structure

• docs/index.md - Main documentation hub with clear navigation and overview
• docs/project-overview.md - Comprehensive introduction to orcpub's purpose, features, and architecture
• docs/getting-started.md - Step-by-step development environment setup with troubleshooting
• docs/technology-overview.md - Beginner-friendly introduction to Clojure, ClojureScript, Reagent, and re-frame
• docs/source-guide.md - Detailed walkthrough of the codebase structure and major components
• docs/development-workflow.md - Daily development process, testing, debugging, and deployment guide
• docs/contributing.md - Complete contribution guide with coding standards and community guidelines

Enhanced README

Updated the main README.md to include prominent links to the new documentation while preserving all existing deployment and Docker information.

Key Features

Beginner-Friendly: Written specifically for developers new to Clojure/ClojureScript, with explanations of functional programming concepts, interactive development (REPL), and the entity-modifier architecture that powers orcpub's character building system.

Educational Content: Each technology section includes:

• Clear explanations of what the technology is and why it's used
• Code examples showing real usage patterns
• Links to official documentation and learning resources
• Practical advice for getting started

Comprehensive Coverage: The documentation covers everything from initial setup through advanced development patterns:

• Prerequisites and tool installation (Java, Leiningen, etc.)
• Database setup with Datomic
• Frontend development with hot-reloading
• Testing strategies and debugging techniques
• Performance optimization and deployment

Practical Examples: Throughout the documentation, real code examples demonstrate:

• How the entity-modifier system works for character building
• re-frame event/subscription patterns
• Adding new D&D content and UI components
• Writing tests for both frontend and backend code

Benefits for Contributors

• Lower barrier to entry: New contributors can get up to speed quickly with detailed setup instructions
• Clear contribution path: The contributing guide provides specific guidance for different types of contributions (bugs, features, content, documentation)
• Educational value: Developers can learn modern functional web development patterns while contributing
• Better code quality: Clear coding standards and testing requirements help maintain project health

The documentation is designed to grow with the project and can be easily extended as new features and technologies are added.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• my.datomic.com
  • Triggering command: java -Dfile.encoding=UTF-8 -Dmaven.wagon.http.ssl.easy=false -Dmaven.wagon.rto=10000 -Xbootclasspath/a:/home/REDACTED/.lein/self-installs/leiningen-2.11.2-standalone.jar -XX:+TieredCompilation -XX:TieredStopAtLevel=1 -Dleiningen.input-checksum= -Dleiningen.original.pwd=/home/REDACTED/work/orcpub/orcpub -Dleiningen.script=/usr/local/bin/lein -classpath /home/REDACTED/.lein/self-installs/leiningen-2.11.2-standalone.jar clojure.main -m leiningen.core.main version (dns block)
• repo.clojars.org
  • Triggering command: java -Dfile.encoding=UTF-8 -Dmaven.wagon.http.ssl.easy=false -Dmaven.wagon.rto=10000 -Xbootclasspath/a:/home/REDACTED/.lein/self-installs/leiningen-2.11.2-standalone.jar -XX:+TieredCompilation -XX:TieredStopAtLevel=1 -Dleiningen.input-checksum= -Dleiningen.original.pwd=/home/REDACTED/work/orcpub/orcpub -Dleiningen.script=/usr/local/bin/lein -classpath /home/REDACTED/.lein/self-installs/leiningen-2.11.2-standalone.jar clojure.main -m leiningen.core.main version (dns block)
• repository.apache.org
  • Triggering command: java -Dfile.encoding=UTF-8 -Dmaven.wagon.http.ssl.easy=false -Dmaven.wagon.rto=10000 -Xbootclasspath/a:/home/REDACTED/.lein/self-installs/leiningen-2.11.2-standalone.jar -XX:+TieredCompilation -XX:TieredStopAtLevel=1 -Dleiningen.input-checksum= -Dleiningen.original.pwd=/home/REDACTED/work/orcpub/orcpub -Dleiningen.script=/usr/local/bin/lein -classpath /home/REDACTED/.lein/self-installs/leiningen-2.11.2-standalone.jar clojure.main -m leiningen.core.main version (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

This pull request was created as a result of the following prompt from Copilot chat.

Create high-quality, developer-friendly documentation for the orcpub project. The documentation should be stored in a dedicated folder (e.g., /docs) using Markdown syntax and should include the following:

1. Project Overview:
   • Introduction to orcpub, its purpose, and main features.
2. Getting Started:
   • Step-by-step instructions for setting up the development environment.
   • Installation prerequisites, including instructions for those new to Clojure and ClojureScript.
3. Technology Overview:
   • Brief introductions to Clojure, ClojureScript, Reagent, and re-frame, with links to further resources.
4. Source File Guide:
   • A readable summary of the source code structure and the purpose of major files and directories.
   • Explanations of key modules/components, with developer-focused comments and usage examples.
5. Development Workflow:
   • Typical development process, building, running, and testing the project.
   • Common tasks and troubleshooting tips.
6. Contribution Guide:
   • How to contribute, coding standards, and where to ask for help.

The documentation should be especially welcoming to developers new to the Clojure ecosystem and provide practical advice, links, and tips. All documentation should be written in clear, beginner-friendly language, and formatted using Markdown for easy navigation and readability.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.