doc: Add documentation styleguide, update some docs to adhere by enjeck · Pull Request #3397 · f3d-app/f3d

enjeck · 2026-07-19T11:05:14Z

Describe your changes

add a documentation style guide
update some docs to adhere to this style guide
fix spelling and grammatical errors
make docs more consistent e.g capitalization, title casing

Checklist for finalizing the PR

I have performed a self-review of my code
I have added tests for new features and bugfixes
I have added documentation for new features
If it is a modifying the libf3d API, I have updated bindings
If it is a modifying the .github/workflows/versions.json, I have updated docker_timestamp

AI Disclosure

I have not used AI to generate any of the content of this pull request
I have used AI to generate code in this pull request:
- I have carefully read and understood the AI policy.
- I have carefully reviewed and completely understood every generated line.
- I disclose below which parts of the code were generated and with which AI model:
  - Claude Opus 4.8 to come up with the good vs bad examples in the style guide, based on F3D's code and use cases

...

Continuous integration

Please write a comment to run CI, eg: \ci fast.
See here for more info.

mwestphal · 2026-07-19T17:45:45Z

Please properly disclose AI usage in the PR description.

mwestphal

Missing AI disclosure.

mwestphal · 2026-07-22T06:05:25Z

Please request a review, top right, whenever needed @enjeck :)

mwestphal · 2026-07-27T06:38:32Z

+- **Documentation only**: no build is required. Write your changes following the [documentation style guide](doc/dev/15-DOCUMENTATION_STYLE.md), then preview them with the [website preview recipe](doc/dev/07-TOOLING.md#how-to-locally-generate-and-run-the-website).
+- **Code contributions**: start with our [Getting Started guide](doc/dev/04-GETTING_STARTED.md), then follow the [Build guide](doc/dev/05-BUILD.md). After that, read the [Architecture](doc/dev/08-ARCHITECTURE.md) page and the [F3D mentoring program](doc/dev/13-MENTORING.md) if you want more guidance.
+
+Once you know which path applies, take a look at the open [issues](https://github.com/f3d-app/f3d/issues).


maybe use the help wanted link ? many issues are not available to pick up by anyone.

I dont see this change

mwestphal

Spectacular work @enjeck !

…nd guidance

mwestphal · 2026-07-28T17:27:25Z

\ci website

mwestphal

LGTM, i've run the website CI

mwestphal · 2026-07-29T05:20:58Z

Nice, lets wait for @Meakk review.

Meakk

Minor clarification, but it looks very good, thanks :)

Meakk · 2026-07-29T07:50:31Z

+| plugin              | reader module, extension, unless explaining internals                                 |
+| reader              | importer, loader, unless the code/API uses those names                                |
+| file format         | file type, when referring to the supported formats table                              |
+| rendering backend   | OpenGL backend, when referring to `--rendering-backend`                               |


It applies to the "OpenGL context", or "rendering window".
I think it may be too ambiguous to talk about "OpenGL backend"

Suggested change

| rendering backend | OpenGL backend, when referring to `--rendering-backend` |

| rendering backend | OpenGL context backend, when referring to `--rendering-backend` |

enjeck requested a review from a team as a code owner July 19, 2026 11:05

mwestphal requested changes Jul 19, 2026

View reviewed changes

F3D Docs added 3 commits July 22, 2026 03:58

doc: add documentation style guide

2b2479b

doc: update CONTRIBUTING with documentation guidance

2c82c48

doc: apply style improvements to existing docs

30e5f12

enjeck force-pushed the improve-doc branch from bd5e0e8 to 30e5f12 Compare July 22, 2026 02:58

enjeck requested a review from mwestphal July 27, 2026 05:26