Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
contribute:documentation [2026/08/27 02:25] – Add initial AI/LLM policy statement for xfce.docs.org kevinbowencontribute:documentation [2026/09/16 01:27] (current) – [Editing the Xfce Documentation] kevinbowen
Line 1: Line 1:
 ~~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]]**
Line 11: Line 11:
 ===== Introduction ===== ===== Introduction =====
  
-Since Xfce 4.10, there are no application manuals in the packages. The reason for this change is that hardly any documentation was contributed over the years mainly because people had problems with the various formats (docbook and mallard) or with the complexity of the VCS(GIT, the Version Control System used by Xfce).+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 lower the documentation barrier, it was decided to start a documentation wiki where contributors, developers and translators can work on good and up-to-date documentation.+In order to encourage a wider range of participation in the Xfce project, it was decided to start this documentation wiki. 
  
-From the various dialogs, links, and help buttons in the Xfce applications, we redirect to the appropriate sections in this wiki.+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]]. 
  
 ---- ----
Line 21: Line 23:
 ===== Contributing ===== ===== Contributing =====
  
-If you want to help extending the application manuals or guides on this wiki, an account can be requested on the [[https://mail.xfce.org/mailman/listinfo/xfce4-dev|xfce4-dev]] mailing list or the [[https://matrix.to/#/#xfce-dev:matrix.org|Matrix channel #xfce-dev]]. Give yourself an introduction and an acount will be setup on docs.xfce.org so you can begin working.+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, the above requirement applies as well as sending an email to the [[https://mail.xfce.org/mailman/listinfo/xfce-i18n|xfce-i18n]] mailing list. Please make sure you also include the language you want to translate. Note that this only applies for an account on docs.xfce.org, 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]].
  
 ---- ----
Line 33: Line 35:
    * Contributors are fully responsible for the accuracy, legality, and quality of their submissions.    * Contributors are fully responsible for the accuracy, legality, and quality of their submissions.
    * For contributors whose primary language is not English, using a tool such as [[https://translate.google.com/|Google translate]] or similar is permitted and considered acceptable. Xfce editors will work with contributors to improve their submitted content.    * For contributors whose primary language is not English, using a tool such as [[https://translate.google.com/|Google translate]] or similar is permitted and considered acceptable. Xfce editors will work with contributors to improve their submitted content.
-   * Low-quality or inappropriate AI-generated content may be rejected, and repeated violations may result in account suspension or ban.+   * Low-quality content may be rejected, and repeated violations may result in account suspension or ban.
  
 ---- ----
  
 ===== 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, just use the [[playground:playground|playground]] page. Just 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. 
 ---- ----