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

[gatsby-transformer-remark] Request to publish sources #2617

Closed
ryaninvents opened this issue Oct 25, 2017 · 1 comment
Closed

[gatsby-transformer-remark] Request to publish sources #2617

ryaninvents opened this issue Oct 25, 2017 · 1 comment

Comments

@ryaninvents
Copy link
Contributor

There are a number of packages that exhibit this problem, so I arbitrarily chose gatsby-transformer-remark.

I understand that there's a lot of work going on with Gatsby, and there's a bit of a backlog of documentation. I believe that it would be beneficial to publish all sources to GitHub and update the package.json for each package with a repository field. Issues do not necessarily need to be turned on for each repo; public availability of the source code would suffice.

Benefits:

  • Since documentation is currently a work in progress across all Gatsby-related projects, publishing the source would allow consumers to read the source if they needed information that the README did not provide. It's not ideal, but it's easier to read the source on GitHub than to install the package and inspect the transpiled sources.
  • The community would be able to contribute documentation to the repos.
  • Similarly, the community would be able to submit bugfixes and feature updates.
@ryaninvents
Copy link
Contributor Author

Oops, embarrassing... didn't realize they were all right here 🤦‍♂️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant