How to modify the documentation?

[rokejulianlockhart]

@rokejulianlockhart

@redstrate

There’s only a handful of people working on Kirigami. Even less are interested in documentation - which is completely fair! An even smaller portion of that group has the time, energy and drive to test it on Windows unfortunately

@redstrate, I’d be willing to test on Windows and write enough documentation to fill your ears.

Yes, I’ve read Formatting your tutorial | Developer. However, it doesn’t appear to state where I’m meant to acquire the documentation from (which you’d expect to be the first section). Do I clone Documentation / Developer Tutorial and Article Site · GitLab (per README.md · ab390d219913d91f1a8835dbe2bfe41fc44cd7d3 · Documentation / Developer Tutorial and Article Site · GitLab)?

I ask because I’ve noticed some erroneous commas at Formatting your tutorial | Developer

• group:, which lists sections with the same name under the same group. It can be seen in action in the Kirigami tutorial, with the groups Introduction, Style, Components, and Advanced. The groups need to be listed in the _index.md file of the tutorial.
• aliases:, which creates aliases that can be used to shorten links. This is useful when linking to that page from elsewhere, or to keep old links working when content is moved.

and want to remediate that.

---

https://wim.nl.tab.digital/apps/tasks/#/collections/all/tasks/B5CDB40C-F639-4248-9DE5-0E0D7DCAF9D0.ics:~:text=14084%2F2%3Fu%3Drokejulianlockhart-,last%20modified,-today%20at%2011

[guss77]

@rokejulianlockhart

Yes, I’ve read Formatting your tutorial | Developer. However, it doesn’t appear to state where I’m meant to acquire the documentation from (which you’d expect to be the first section). Do I clone Documentation / Developer Tutorial and Article Site · GitLab?

That seems - more or less - as the correct thing to do. Specifically:

1. Create an account on invent.kde.org
2. Fork the project develop-kde-org with your account.
3. Clone the resulting fork, which will be a repository you own.
4. Run the testing setup as documented in the README.
5. Fix the documentation and test locally.
6. Commit and push your changes.
7. Go to your project on invent.kde.org and and submit a merge request.

Good luck!

[rokejulianlockhart]

@guss77

That seems - more or less - as the correct thing to do.

Thanks, @guss77:

Minor improvements to `formatting.md`. (!389) · Merge requests · Documentation...