mirror of https://github.com/JuliaFEM/JuliaFEM.jl.git synced 2026-08-06 04:21:33 +00:00

Files

T

Jukka Aho 626266c990 docs: Reorganize documentation into three-tier structure

**Three Manuals for Three Audiences:**

1. **User Manual** (docs/user/) - "Just Get It Done"
   - For end users, engineers, students
   - Simple, practical, step-by-step
   - Quick start, tutorials, examples, troubleshooting
   - Philosophy: Show me how to solve my problem

2. **Contributor Manual** (docs/contributor/) - "Show Me the Code"
   - For developers, contributors, advanced users
   - Technical, detailed, design rationale
   - Testing, architecture, performance, CI/CD
   - Philosophy: Explain HOW and WHY

3. **The JuliaFEM Book** (docs/book/) - "Let Me Show You How I Think"
   - For researchers, theory nerds, and Jukka
   - Comprehensive, educational, opinionated, personal
   - Math foundations, design philosophy, history, research
   - Philosophy: Mix theory, code, and personal experience

**Reorganization:**
- Moved: TESTING_PHILOSOPHY.md → contributor/testing_philosophy.md
- Moved: STATUS.md → contributor/status.md
- Moved: TEST_FIXES_NEEDED.md → contributor/test_fixes_needed.md
- Moved: lagrange_basis_functions.md → book/lagrange_basis_functions.md
- Moved: benchmarks/ → book/benchmarks/
- Created: docs/README.md (main index explaining structure)
- Created: README.md in each section explaining audience and contents
- Updated: All references in scripts and source files

**Naming:** All docs now lowercase (testing_philosophy not TESTING_PHILOSOPHY)

**Benefits:**
- Clear separation of concerns
- Users don't get overwhelmed with implementation details
- Contributors get technical depth
- Book preserves deep theory and personal insights
- Each manual optimized for its audience

**Next:** Populate each section with appropriate content

2025-11-09 04:38:28 +02:00

README.md

docs: Reorganize documentation into three-tier structure

2025-11-09 04:38:28 +02:00

README.md

JuliaFEM User Manual

Audience: End users, engineers, students who want to run simulations and get results.

This manual is designed to be simple and practical - get you from zero to running simulations as quickly as possible.

What's Here

Quick Start: Installation and first simulation in 5 minutes
Tutorials: Step-by-step guides for common problems
Examples: Pre-built simulations you can run and modify
API Reference: Function documentation (what does this do?)
Troubleshooting: Common errors and how to fix them

What's NOT Here

Deep theory (see docs/book/ for that)
How to contribute code (see docs/contributor/ for that)
Internal architecture details

Philosophy

"Just show me how to solve my problem."

We assume you:

Have a problem to solve (heat transfer, elasticity, contact)
Want working code, not lectures
Will read theory when YOU need it, not when WE think you should

Getting Help

Start with the Quick Start
Find an example similar to your problem
Modify it to fit your needs
If stuck, check Troubleshooting
Still stuck? Ask on GitHub Discussions

Next: Start with Quick Start or browse Examples