Skip to content

Commit d9d49a0

Browse files
committed
Merge branch 'develop' of https://github.com/aui-framework/aui into develop
2 parents bbb7b59 + 2d6cc3e commit d9d49a0

File tree

4 files changed

+20
-3
lines changed

4 files changed

+20
-3
lines changed

docs/contributing.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,21 @@ Suppose whe want to create a module called `aui::my_module`:
139139

140140
### Documentation
141141

142+
!!! tip "Recommended: easy way to contribute"
143+
144+
Want to fix a typo or make a small documentation improvement? You can do it directly through GitHub:
145+
146+
1. Navigate to top right corner of the page you would like to contribute to and click "Edit this page".
147+
![](imgs/Screenshot_20250828_155724.png)
148+
2. On GitHub's edit page, you'll be prompted to fork the AUI repository if needed
149+
3. Make your changes in the editor.
150+
4. Commit your changes and create a pull request to https://github.com/aui-framework/aui
151+
5. Once our documentation pipelines verify the changes, we'll merge your contribution.
152+
153+
This process is perfect for minor documentation updates and doesn't require setting up a local development
154+
environment.
155+
156+
142157
The docs found on [aui-framework.github.io](https://aui-framework.github.io) is generated with MkDocs.
143158

144159
To generate documentation, run the following command from the root of AUI repository:

docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@
1010

1111
=== ":material-microsoft-visual-studio-code: VS Code"
1212

13-
1. Install following extensions:
13+
- Install following extensions:
1414

1515
| Extension | Description |
1616
| ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
1717
| [cpp tools pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack) | Introduces basic C/C++ support and CMake integration. |
1818
| [vscode-clangd](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd) | C++ language server for extensive code navigation, autocomplete, etc. |
1919

20-
2. Add these lines to your `settings.json` (++f1++ `> Preferences: Open User Settings (JSON)`):
20+
- Add these lines to your `settings.json` (++f1++ `> Preferences: Open User Settings (JSON)`):
2121

2222
```json title="settings.json"
2323
"clangd.arguments": [
387 KB
Loading

mkdocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,6 @@ nav:
155155
- aui-command-line-arguments.md
156156
- runtime-dependency-resolution.md
157157
- forking-aui.md
158-
- contributing.md
159158

160159
- Reference:
161160
- 'Installation methods':
@@ -169,3 +168,6 @@ nav:
169168
- aui_module.md
170169
- aui-configure-flags.md
171170
- app-build-overview.md
171+
172+
- contributing.md
173+

0 commit comments

Comments
 (0)