mirror of
https://github.com/JuliaFEM/JuliaFEM.jl.git
synced 2026-10-03 14:47:55 +00:00
docs: Remove duplicate title from documentation README
Remove duplicate "JuliaFEM Documentation" header (line 11) and add blank lines for consistent list formatting in three-manual organization document. Changes: - Line 11: Removed duplicate H1 title (already in frontmatter) - Lines 22, 41, 61, 110: Added blank lines before list items for markdown clarity - Maintains three-audience structure: Users, Contributors, Researchers - Preserves content organization and cross-reference section This is a formatting-only change to improve readability. No content modified.
This commit is contained in:
+4
-2
@@ -8,8 +8,6 @@ keywords: ["juliafem", "finite element", "documentation", "manual"]
|
||||
type: "index"
|
||||
---
|
||||
|
||||
# JuliaFEM Documentation
|
||||
|
||||
Welcome! JuliaFEM documentation is organized into **three manuals** for three different audiences:
|
||||
|
||||
---
|
||||
@@ -21,6 +19,7 @@ Welcome! JuliaFEM documentation is organized into **three manuals** for three di
|
||||
**Style:** Simple, practical, step-by-step.
|
||||
|
||||
**Contents:**
|
||||
|
||||
- Quick start and installation
|
||||
- Tutorials and examples
|
||||
- API reference
|
||||
@@ -39,6 +38,7 @@ Welcome! JuliaFEM documentation is organized into **three manuals** for three di
|
||||
**Style:** Technical, detailed, design rationale.
|
||||
|
||||
**Contents:**
|
||||
|
||||
- Testing philosophy
|
||||
- Code style and architecture
|
||||
- Performance guidelines
|
||||
@@ -58,6 +58,7 @@ Welcome! JuliaFEM documentation is organized into **three manuals** for three di
|
||||
**Style:** Comprehensive, educational, opinionated, personal.
|
||||
|
||||
**Contents:**
|
||||
|
||||
- Mathematical foundations (Lagrange basis, contact mechanics, etc.)
|
||||
- Design philosophy and technical vision
|
||||
- Strategic mistakes and lessons learned (2015-2019)
|
||||
@@ -106,6 +107,7 @@ Mixing these audiences in one manual makes it too complex for users and too shal
|
||||
### Cross-References
|
||||
|
||||
Manuals link to each other when appropriate:
|
||||
|
||||
- User manual links to theory when deeper understanding helps
|
||||
- Contributor manual links to book for design rationale
|
||||
- Book links to code examples and practical guides
|
||||
|
||||
Reference in New Issue
Block a user