atom / atom.io

🌐 A place for feedback on the atom.io website and package API
159 stars 101 forks source link

Add way to document services provided by Atom default-installed packages #34

Open lee-dohm opened 9 years ago

lee-dohm commented 9 years ago

I feel like the services provided or consumed by the Atom default-installed packages (autocomplete-plus, status-bar, tree-view, tabs, etc) should be documented in a central location rather than only in the package README. This would make the most sense in the developer documentation, but there isn't a way to include this currently implemented.

Please add a capability to document Atom provided or consumed services in the developer documentation.

thomasjo commented 9 years ago

Agreed, I think this would a great enhancement/addition.

ghost commented 7 years ago

I think this is a great idea and, in the spirit of this post on reddit, we could take this even one step further and add a way to display all Atom packages that expose services (or maybe allow packages to demarcate that they are solely intended for consumption by other packages).

There are quite a few packages already that expose neat functionality that can be consumed by others:

All these packages can be of great help if you're looking to develop a new package. It also helps making the user experience in Atom more consistent by sharing the same front end for various tasks. It's not always as easy to discover which reusable packages currently exist, as they blend in with the rest of the "normal" packages.