Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation about writing extensions #810

Closed
geoand opened this issue Feb 8, 2019 · 2 comments
Closed

Documentation about writing extensions #810

geoand opened this issue Feb 8, 2019 · 2 comments
Labels
triage/duplicate This issue or pull request already exists

Comments

@geoand
Copy link
Contributor

geoand commented Feb 8, 2019

Opening this based on a discussion on the mailing list:

Regardless of how complex it will be to write an extension, I believe that superb documentation will be necessary if we wish to build an ecosystem ( and it would be a damn shame if this amazing project does not get one :) ).
I would very much like to see both the general concerns that an extension needs to handle and a detailed section including various how-tos. Having links to how existing extensions solve various common problems would be great as well. Although I do expect people will have to look at the code of existing extensions and possibly the core, trying to minimize that as much as possible via great documentation will reduce friction IMHO.

@michaelpaesold
Copy link

There is actually some work in progress regarding improved extension documentation, see #1964.

@emmanuelbernard
Copy link
Member

Dupe of #2277

@emmanuelbernard emmanuelbernard added the triage/duplicate This issue or pull request already exists label Jul 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage/duplicate This issue or pull request already exists
Projects
None yet
Development

No branches or pull requests

3 participants