| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| contribute:documentation [2026/09/15 23:09] – kevinbowen | contribute:documentation [2026/09/16 01:27] (current) – [Editing the Xfce Documentation] kevinbowen |
|---|
| ~~NOTOC~~ | ~~NOTOC~~ |
| ====== Documentation ====== | ====== Documentation ====== |
| |
| |
| * **[[#Contributing|Contributing]]** | * **[[#Contributing|Contributing]]** |
| * **[[#AI/LLM Assisted Contribution Policy|AI/LLM Assisted Contribution Policy]]** | * **[[#AI/LLM Assisted Contribution Policy|AI/LLM Assisted Contribution Policy]]** |
| * **[[#Reporting Bugs|Reporting Bugs]]** | * **[[#Reporting Bugs|Reporting Bugs]]** |
| | * **[[#Requesting Editing Access|Requesting Editing Access]]** |
| * **[[#Editing the Documentation|Editing the Documentation]]** | * **[[#Editing the Documentation|Editing the Documentation]]** |
| * **[[#Screenshots|Screenshots]]** | * **[[#Screenshots|Screenshots]]** |
| Since the release of Xfce 4.10(2012), man pages(application manuals) are no longer being provided with the Xfce packages. Low contribution and complexity were the primary motivating factors for this change. | Since the release of Xfce 4.10(2012), man pages(application manuals) are no longer being provided with the Xfce packages. Low contribution and complexity were the primary motivating factors for this change. |
| |
| In order to encourage a wider range of participation in the Xfce project, it was decided to start this documentation wiki. Contributors, developers, translators, and end-users are all encouraged to help work on improving and maintaining up-to-date Xfce documentation. | In order to encourage a wider range of participation in the Xfce project, it was decided to start this documentation wiki. |
| |
| Users will be redirected to the appropriate documentation sections on the [[:start:|docs.xfce.org]] wiki from within the various Xfce application dialog windows, links, and help buttons. | Contributors, developers, translators, and end-users are all encouraged to help work on improving and maintaining up-to-date Xfce documentation. |
| | |
| | Within the various Xfce application dialog windows, links, and help buttons, users are redirected to the appropriate documentation sections on the [[:start:|docs.xfce.org]]. |
| |
| ---- | ---- |
| ===== Contributing ===== | ===== Contributing ===== |
| |
| If you want to help extending the documentation here, an account can be requested on the [[https://matrix.to/#/#xfce-dev:matrix.org|#xfce-dev Matrix channel]]. Give yourself an introduction and an account will be setup on docs.xfce.org so you can begin contributing to the Xfce project. | If you want to help improving the Xfce documentation, an account can be requested on the [[https://matrix.to/#/#xfce-dev:matrix.org|#xfce-dev Matrix channel]]. Give yourself an introduction and an account will be setup on docs.xfce.org so you can begin contributing to the Xfce project. |
| |
| For translators, please visit our [[https://matrix.to/#/#xfce-translation:matrix.org|#xfce-translation Matrix channel]]. Please make sure to include the language you are interested in translating. Information about code translation can be found [[contribute:translate:|here]]. | For translators, please visit our [[https://matrix.to/#/#xfce-translation:matrix.org|#xfce-translation Matrix channel]]. Please make sure to include the language you are interested in translating. Information about code translation can be found [[contribute:translate:|here]]. |
| |
| ===== Reporting Bugs ===== | ===== Reporting Bugs ===== |
| If you happen to find a typo, dead link, missing or outdated images in the Xfce or Wiki documentation, your way of helping getting things getting fixed to report a bug about it. Learn here about submitting a bug and to see what bugs are currently outstanding. | |
| | If you happen to find a typo, dead link, missing or outdated images in the Xfce or Wiki documentation, your way of helping getting things fixed is to report a bug about it. Learn here about submitting a bug and to see what bugs are currently outstanding. |
| |
| * **[[:contribute:documentation:bugs|Reporting Bugs]]** -- Open bug reports and how to report new bugs | * **[[:contribute:documentation:bugs|Reporting Bugs]]** -- Open bug reports and how to report new bugs |
| |
| If you see an open bug, here, that you think that you may be able to fix it; this is a great way to start contributing to Xfce even if you are not a programmer. | If you see an open bug that you think you may be able to fix, this is a great way to start contributing to Xfce even if you are not a programmer. |
| ---- | ---- |
| |
| ===== Editing the Documentation ===== | ===== Requesting Editing Access ====== |
| | |
| | If you wish to have editing access to the Xfce documentation, please reach out to us either through the [[https://matrix.to/#/#xfce-dev:matrix.org|#xfce-dev Matrix channel]]. See the [[:contribute:dev/start#communication_with_the_xfce_development_team|Communication with the Xfce Development]] for additional information. |
| | |
| | ---- |
| | |
| | ===== Editing the Xfce Documentation ===== |
| | |
| | The [[:start|Xfce documentation]] wiki is built upon the [[https://www.dokuwiki.org/dokuwiki|DokuWiki]] software platform. DokuWiki uses a simplified markup language for page formatting. |
| | |
| | Use either the [[doku>DokuWiki]] article or the local [[/wiki/syntax|syntax]] page for guidance and reference when editing pages. |
| |
| If you are unfamiliar with, or simply need a refresher, take a look at the [[doku>DokuWiki]] [[/wiki/syntax|syntax]] page for guidance. | We also have a 'playground' page available for practice use, and provides and area for safe experimentation that will not affect existing documetation. If you want to try something out before editing a page, use the [[playground:playground|playground]] page. Remember to leave the playground as you found it for others to have a blank slate to experiment with their documentation. |
| |
| If you want to try something out before editing a page, use the [[playground:playground|playground]] page. Remember to leave the playground as you found it for others to have a blank slate to experiment with their documentation. | Generally, most edits will be made on already existing pages. |
| | However, if a new page needs to be created, please refer to [[:contribute:documentation:creating_new_pages|formatting guidelines for new pages]] on details for maintaining a consistent document structure across the Xfce documentation pages. |
| |
| If you wish to have editing access to either the documentation, or the wiki, please reach out to us either through [[irc://irc.libera.chat/#xfce-dev|#xfce-dev on Libera]] or the [[https://mail.xfce.org/mailman/listinfo/xfce4-dev|Xfce-dev mailing list]]. See the [[:contribute:dev/start#communication_with_the_xfce_development_team|Communication with the Xfce Development]] for additional information. | |
| ---- | ---- |
| |