Skip to content

Commit b4d59b5

Browse files
committed
fixes #29
remove title and description fom all markdown files. Make them explicit in text
1 parent 3a243b8 commit b4d59b5

File tree

12 files changed

+26
-59
lines changed

12 files changed

+26
-59
lines changed

codeformatting/c++.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
---
2-
title: C++ Code Code Formatting Guidelines
3-
description:
4-
Guidelines for code formatting in Python
52
layout: default
63
---
74

8-
# {{page.title}}
5+
# C++ Code Code Formatting Guidelines
96

10-
{{page.description}}
7+
Guidelines for code formatting in Python
118

129
Content goes here

codeformatting/index.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
---
2-
title: Code Formatting Guidelines
3-
description:
4-
Guidelines for code formatting in C++ and Python
52
layout: default
63
---
74

8-
# {{page.title}}
5+
# Code Formatting Guidelines
96

10-
{{page.description}}
7+
Guidelines for code formatting in C++ and Python
118

129
FreeCAD is written primarily in C++ and Python (with a few files in other languages such as CMake). To smooth the process of merging new contributions it is desirable to minimize formatting changes to existing code, and to use a uniform code formatting style when writing new code. Eventually we expect to standardize the codebase on specific coding styles using Clang Format for C++ and a Python code-formatter (such as Black), but that is a work-in-progress and _should not_ be applied to existing otherwise-untouched code.
1310

codeformatting/python.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
---
2-
title: Python Code Code Formatting Guidelines
3-
description:
4-
Guidelines for code formatting in Python
52
layout: default
63
---
74

8-
# {{page.title}}
5+
# Python Code Code Formatting Guidelines
96

10-
{{page.description}}
7+
Guidelines for code formatting in Python
118

129
Use Black.
1310

gettingstarted/index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
2-
title: Getting Started
3-
description: Covers how to set up a build environment for contributing to FreeCAD
42
layout: default
53
---
64

7-
# {{page.title}}
5+
# Getting Started
86

9-
{{page.description}}
7+
Covers how to set up a build environment for contributing to FreeCAD
108

119
Working on FreeCAD is similar to working on may other open-source projects. This guide provides a short overview of the process. Much more information can be found at https://wiki.freecad.org.
1210

maintainersguide/index.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
title: Maintainers Guide
3-
description:
4-
Guidelines for Maintainers regarding code review and merge procedures.
52
layout: default
63
---
74

8-
# {{page.title}}
5+
# Maintainers Guide
6+
7+
Guidelines for Maintainers regarding code review and merge procedures.
98

10-
{{page.description}}
119

1210
## The role of a Maintainer
1311

roadmap/index.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
---
2-
title: Roadmap
3-
description:
4-
The roadmap provides broad objectives for the direction of FreeCAD development
52
layout: default
63
---
74

8-
# {{page.title}}
5+
Roadmap
96

10-
{{page.description}}
7+
The roadmap provides broad objectives for the direction of FreeCAD development
118

129
# Development Roadmap 1.0
1310

stylebook/index.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
---
2-
title: Stylebook
3-
description:
4-
The stylebook provides guidelines and explanations for visual elements in the FreeCAD application
52
layout: default
63
---
74

8-
# {{page.title}}
5+
# Stylebook
96

10-
{{page.description}}
7+
The stylebook provides guidelines and explanations for visual elements in the FreeCAD application
118

129
This book is meant to document the general style and conventions of the FreeCAD User Interface. Guidelines, terminology, and philosophies described here will be used to justify changes in the current UI in order to make the overall user experience more consistent, predictable, intuitive, and attractive in the future.
1310

technical/SourceTreeBasics.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
---
2-
title: "Partial View of the FreeCAD Source Tree"
3-
description:
4-
"A picture of the most commonly encountered branches of the tree."
52
layout: default
63
mermaid: true
74
---
8-
# {{page.title}}
5+
# "Partial View of the FreeCAD Source Tree"
96

10-
{{page.description}}
7+
"A picture of the most commonly encountered branches of the tree."
118

129
{{page.mermaid}}
1310

technical/TheApplicationModule.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
title: "The Application Module"
3-
description:
4-
"An overview of application module structure."
52
layout: default
63
mermaid: true
74
---
8-
# {{page.title}}
95

10-
{{page.description}}
6+
# "The Application Module"
7+
8+
"An overview of application module structure."
119

1210
The functionality of FreeCAD is separated into Modules. Some Modules are built into FreeCAD and some are Extension Modules (a form of plug-in). Once installed, Extension Modules behave exactly as built-in Modules.
1311

technical/developerglossary.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
---
2-
title: "Developer's Glossary"
3-
description:
4-
"Some terms that a developer may run across."
52
layout: default
63
---
7-
# {{page.title}}
4+
# "Developer's Glossary"
85

9-
{{page.description}}
6+
"Some terms that a developer may run across."
107

118
Note that there may be subtle differences in how some terms are used by deveopers vs how they are used by users.
129

0 commit comments

Comments
 (0)