Skip to content

Commit 8b5843e

Browse files
authored
📝 Restructure Docs section in Contributing page (#10844)
📝 Restructure Docs section in Contributing page
1 parent 5826c4f commit 8b5843e

File tree

1 file changed

+32
-26
lines changed

1 file changed

+32
-26
lines changed

docs/en/docs/contributing.md

Lines changed: 32 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -150,32 +150,7 @@ For it to sort them correctly, you need to have FastAPI installed locally in you
150150

151151
First, make sure you set up your environment as described above, that will install all the requirements.
152152

153-
The documentation uses <a href="https://www.mkdocs.org/" class="external-link" target="_blank">MkDocs</a>.
154-
155-
And there are extra tools/scripts in place to handle translations in `./scripts/docs.py`.
156-
157-
!!! tip
158-
You don't need to see the code in `./scripts/docs.py`, you just use it in the command line.
159-
160-
All the documentation is in Markdown format in the directory `./docs/en/`.
161-
162-
Many of the tutorials have blocks of code.
163-
164-
In most of the cases, these blocks of code are actual complete applications that can be run as is.
165-
166-
In fact, those blocks of code are not written inside the Markdown, they are Python files in the `./docs_src/` directory.
167-
168-
And those Python files are included/injected in the documentation when generating the site.
169-
170-
### Docs for tests
171-
172-
Most of the tests actually run against the example source files in the documentation.
173-
174-
This helps making sure that:
175-
176-
* The documentation is up to date.
177-
* The documentation examples can be run as is.
178-
* Most of the features are covered by the documentation, ensured by test coverage.
153+
### Docs live
179154

180155
During local development, there is a script that builds the site and checks for any changes, live-reloading:
181156

@@ -229,6 +204,37 @@ Completion will take effect once you restart the terminal.
229204

230205
</div>
231206

207+
### Docs Structure
208+
209+
The documentation uses <a href="https://www.mkdocs.org/" class="external-link" target="_blank">MkDocs</a>.
210+
211+
And there are extra tools/scripts in place to handle translations in `./scripts/docs.py`.
212+
213+
!!! tip
214+
You don't need to see the code in `./scripts/docs.py`, you just use it in the command line.
215+
216+
All the documentation is in Markdown format in the directory `./docs/en/`.
217+
218+
Many of the tutorials have blocks of code.
219+
220+
In most of the cases, these blocks of code are actual complete applications that can be run as is.
221+
222+
In fact, those blocks of code are not written inside the Markdown, they are Python files in the `./docs_src/` directory.
223+
224+
And those Python files are included/injected in the documentation when generating the site.
225+
226+
### Docs for tests
227+
228+
Most of the tests actually run against the example source files in the documentation.
229+
230+
This helps making sure that:
231+
232+
* The documentation is up to date.
233+
* The documentation examples can be run as is.
234+
* Most of the features are covered by the documentation, ensured by test coverage.
235+
236+
237+
232238
### Apps and docs at the same time
233239

234240
If you run the examples with, e.g.:

0 commit comments

Comments
 (0)