linuxmint / linuxmint/cinnamon

Better documentation of the Cinnamon API

Open
#3,186 36 comments 16 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
5.6k
Forks
915
Avg merge
5d 22h
Merged PRs (30d)
3

Description

A thing I hate about Cinnamon (as a fairly unexerienced developer in this area) is the lack of an API documentation.

Even the most simple applet becomes hard to create - The only thing I could find was the Force Quit/xkill applet tutorial.

I think this is quite a sad fact, because Cinnamon is continuosly gaining popularity. With such a growing community comes a greater amount of developers.

JavaScript itself is easy to learn, but where am I supposed to learn the Cinnamon-specific stuff? Of course I can try to understand the commands and classes from the given applets, but so I will never learn what every specific command exactly does and I will certainly never know what commands exist.

So I think a complete API documentation for Applets, Desklets and Extensions is crucial for Cinnamon.


I already filed this at community.linuxmint.com, and they asked me to write this here

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing Force Quit/xkill applet tutorial and review the current documentation for Applets, Desklets, and Extensions. Define the API areas and documentation scope before proceeding; done means developers can find and understand the Cinnamon-specific commands and classes needed to build these components.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.