mirror of
https://github.com/JuliaFEM/JuliaFEM.jl.git
synced 2026-08-06 04:21:33 +00:00
Jukka Aho
1636e255fe
**Purpose:** Prepare documentation for publishing as blog posts or book **YAML Headers Include:** - title: Document title - subtitle: Optional subtitle for context - description: Brief summary for SEO/indexing - date: Creation date - updated: Last update date (for status docs) - author: Jukka Aho - categories: Taxonomic classification - keywords: Search/indexing keywords - audience: Target reader (users/contributors/researchers) - level: Difficulty level (beginner/intermediate/advanced/expert) - type: Document type (manual/guide/theory/benchmark/status) - series: Which manual it belongs to - chapter: Book structure (for The JuliaFEM Book) - status: Current state (completed/work in progress/active maintenance) - math: Whether document contains mathematical notation - prerequisites: Required background knowledge - tools: Software/packages used (for benchmarks) - context: Background information **Files Updated:** - docs/README.md (main index) - docs/user/README.md (user manual index) - docs/contributor/README.md (contributor manual index) - docs/book/README.md (book index) - docs/contributor/testing_philosophy.md - docs/contributor/status.md - docs/contributor/test_fixes_needed.md - docs/book/lagrange_basis_functions.md - docs/book/benchmarks/shape_function_derivatives_ad_vs_manual.md - scripts/README.md **Benefits:** - Ready for static site generators (Jekyll, Hugo, MkDocs) - Can generate book with proper metadata - SEO-friendly with descriptions and keywords - Clear audience/level targeting - Trackable with dates and status - Organized by series and chapters **Compatible With:** - Jekyll (GitHub Pages) - Hugo (fast static site generator) - MkDocs (Python-based documentation) - Jupyter Book (interactive books) - Docusaurus (React-based docs) - Custom publishing scripts
1.5 KiB
1.5 KiB
title, description, date, author, categories, keywords, audience, level, type
| title | description | date | author | categories | keywords | audience | level | type | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| JuliaFEM User Manual | Quick start guide and practical tutorials for end users | 2025-11-09 | Jukka Aho |
|
|
end users | beginner | manual |
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