Community: Difference between revisions

Add community and editorial guidance page
 
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= Community =
= Community =


'''Community''' describes how people can use this wiki as a shared editorial and technical record for PlexyDesk.
This is where contributors help turn this wiki into a clear, shared record of how PlexyDesk works.


== Ways to contribute ==
The goal is simple: keep the documentation close to the real system. That includes the code, the runtime behaviour, the visible desktop, and the interfaces exposed to applications and tools. The wiki should be useful both to people actively working on PlexyDesk and to readers who are trying to understand it from the outside.
* improve explanatory pages when architecture or behaviour becomes clearer
* upload screenshots, diagrams, icons, and short videos that help explain the desktop
* use article talk pages to discuss wording, structure, and missing references
* keep source-backed technical pages aligned with the code and the generated API reference


== Useful places around the site ==
== How people can contribute ==
* [[Special:Upload]] for images and video
There are many useful ways to contribute:
* [[Special:RecentChanges]] for a live view of ongoing edits
* improve architecture, component, and API pages as behaviour becomes clearer
* add diagrams, screenshots, and short demo media that show how PlexyDesk behaves at runtime
* update source-oriented pages when code structure or exposed interfaces change
* use article talk pages to point out missing details, unclear wording, or technical mistakes
* help connect related pages so the documentation is easier to follow
 
Not every contribution needs to be large. Small fixes, clearer wording, better screenshots, and accurate cross links / refs all make the wiki more useful over time.
 
== Media contributions ==
Visual material is an important part of documenting PlexyDesk. Screenshots, diagrams, and short demo captures can often explain behavior more quickly than text alone.
 
Useful pages:
* [[Gallery]] is the main index for screenshots and short demo captures
* [[Desktop Submissions]] explains how to prepare, upload, and list desktop screenshots
* [[Special:Upload]] is the upload page for image and video files
 
When uploading media, it helps to:
* choose filenames that describe what the media shows
* write short captions that explain the behavior or feature being documented
* prefer real runtime captures over promotional material
* include version, hardware, or environment details when they are relevant
 
== Useful pages ==
A few pages are especially helpful when navigating the wiki:
* [[Documentation]] for the main documentation map
* [[Special:RecentChanges]] for a live view of current edits
* [[Special:AllPages]] for the full page index
* [[Special:AllPages]] for the full page index
* [[Documentation]] for the main reading map
* [[News]] for milestone summaries and documentation updates
* [[News]] for the current project chronicle
 
== Writing style and content conventions ==
This wiki should stay practical and technically grounded.
 
Pages should:
* use clear technical language
* avoid marketing claims
* describe behavior that is implemented, observable, or directly supported by the codebase
* clearly mark planned or experimental ideas instead of presenting them as finished behavior
* stay specific enough to be useful to both contributors and readers
 
Captions, summaries, and page text should explain things as plainly and accurately as possible. A good page does not just name a feature; it helps the reader understand what it does, where it fits, and how it behaves.
 
== Talk pages and discussion ==
Talk pages are there to make pages better. They can be used to:
* question wording that feels unclear or misleading
* point out missing information
* discuss technical accuracy
* suggest better structure or linking
 
As PlexyDesk evolves, the wiki should evolve with it. Keeping pages current is part of the work, and even small updates help preserve a useful technical record.


== Editorial direction ==
[[Category:Communication]]
This wiki is meant to feel like a serious technical publication. Pages should explain the system clearly, avoid inflated claims, and stay close to what the source tree and runtime actually support. The goal is a record that is readable to newcomers and still useful to engineers.
[[Category:Documentation]]

Latest revision as of 17:52, 24 March 2026

Community

[edit | edit source]

This is where contributors help turn this wiki into a clear, shared record of how PlexyDesk works.

The goal is simple: keep the documentation close to the real system. That includes the code, the runtime behaviour, the visible desktop, and the interfaces exposed to applications and tools. The wiki should be useful both to people actively working on PlexyDesk and to readers who are trying to understand it from the outside.

How people can contribute

[edit | edit source]

There are many useful ways to contribute:

  • improve architecture, component, and API pages as behaviour becomes clearer
  • add diagrams, screenshots, and short demo media that show how PlexyDesk behaves at runtime
  • update source-oriented pages when code structure or exposed interfaces change
  • use article talk pages to point out missing details, unclear wording, or technical mistakes
  • help connect related pages so the documentation is easier to follow

Not every contribution needs to be large. Small fixes, clearer wording, better screenshots, and accurate cross links / refs all make the wiki more useful over time.

Media contributions

[edit | edit source]

Visual material is an important part of documenting PlexyDesk. Screenshots, diagrams, and short demo captures can often explain behavior more quickly than text alone.

Useful pages:

  • Gallery is the main index for screenshots and short demo captures
  • Desktop Submissions explains how to prepare, upload, and list desktop screenshots
  • Special:Upload is the upload page for image and video files

When uploading media, it helps to:

  • choose filenames that describe what the media shows
  • write short captions that explain the behavior or feature being documented
  • prefer real runtime captures over promotional material
  • include version, hardware, or environment details when they are relevant

Useful pages

[edit | edit source]

A few pages are especially helpful when navigating the wiki:

Writing style and content conventions

[edit | edit source]

This wiki should stay practical and technically grounded.

Pages should:

  • use clear technical language
  • avoid marketing claims
  • describe behavior that is implemented, observable, or directly supported by the codebase
  • clearly mark planned or experimental ideas instead of presenting them as finished behavior
  • stay specific enough to be useful to both contributors and readers

Captions, summaries, and page text should explain things as plainly and accurately as possible. A good page does not just name a feature; it helps the reader understand what it does, where it fits, and how it behaves.

Talk pages and discussion

[edit | edit source]

Talk pages are there to make pages better. They can be used to:

  • question wording that feels unclear or misleading
  • point out missing information
  • discuss technical accuracy
  • suggest better structure or linking

As PlexyDesk evolves, the wiki should evolve with it. Keeping pages current is part of the work, and even small updates help preserve a useful technical record.