Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upImprove documentation on variables and reusables #210
Comments
|
@casals Those two docs could definitely be better! Any thoughts about what kinds of information you think would be helpful there? |
|
Sure - for specific As for IMHO this particular document should be structure more like a quick start guide - "welcome, here's the basic stuff you need to know, here's why you need to know it, here's where you can learn more about each of them" - paced, with simple examples. Perhaps something like this. |
…for-listing-an-app.md to content/developers/github-marketplace-production-sponsorship-for-free-listing-an-app.md App creators might have more incentives to perfect their craft if their names were on the published apps or extensions instead of #id or distribution I'd. github#210 recycling apps so the company can show profits but design your platforms to keep people searching, who-is really wanting redemption not I.
What article on docs.github.com is affected?
The specific
README.mdfiles for both variables and reusables;CONTRIBUTING.mdWhat part(s) of the article would you like to see updated?
As they are now, these files are a little bit dry - it's not something that's intuitively usable by first-time contributors. I suggest both of these files could be updated to look like the one for liquid tabs, with references, usage examples, etc.
Also - adding a brief section on each of these (liquid tabs, variables, reusables, etc) would be extremely helpful.