Glassvision/JuliaFEM.jl
1
0
Fork 0
mirror of https://github.com/JuliaFEM/JuliaFEM.jl.git synced 2026-09-11 22:21:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Reorganize documentation into three-tier structure

Browse Source 
**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
This commit is contained in:
Jukka Aho
2025-11-09 04:38:28 +02:00
parent 5141fd6de5
commit 626266c990
12 changed files with 298 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/README.md
+2 -2
View File
@@ -35,7 +35,7 @@ julia --project=. scripts/generate_lagrange_basis.jl
- `src/basis/lagrange_generated.jl` (commit this file!)
**Theory:**
See `src/lagrange_basis_functions.md` for mathematical foundation.
See `docs/book/lagrange_basis_functions.md` for mathematical foundation.
**Architecture:**
@@ -130,6 +130,6 @@ Pre-compute stiffness matrices for simple elements.
**See also:**
- `src/lagrange_basis_functions.md` - Mathematical theory
- `docs/book/lagrange_basis_functions.md` - Mathematical theory
- `src/basis/lagrange_generator.jl` - Symbolic generation engine
- `llm/VISION_2.0.md` - Overall project architecture
scripts/generate_lagrange_basis.jl
+2 -2
View File
@@ -21,7 +21,7 @@
# - After modifying lagrange_generator.jl
#
# THEORY:
# See src/lagrange_basis_functions.md for full mathematical details
# See docs/book/lagrange_basis_functions.md for full mathematical details
#
# ==============================================================================
@@ -617,7 +617,7 @@ println(output, "# cd /path/to/JuliaFEM.jl")
println(output, "# julia --project=. scripts/generate_lagrange_basis.jl")
println(output, "#")
println(output, "# Theory:")
println(output, "# See src/lagrange_basis_functions.md")
println(output, "# See docs/book/lagrange_basis_functions.md")
println(output, "#")
println(output, "# Generator:")
println(output, "# src/basis/lagrange_generator.jl (symbolic engine)")