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

Improve documentation on variables and reusables #210

Open
casals opened this issue Oct 7, 2020 · 2 comments
Open

Improve documentation on variables and reusables #210

casals opened this issue Oct 7, 2020 · 2 comments

Comments

@casals
Copy link
Contributor

@casals casals commented Oct 7, 2020

What article on docs.github.com is affected?

The specific README.md files for both variables and reusables; CONTRIBUTING.md

What 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.

@github-actions github-actions bot added the triage label Oct 7, 2020
@github-actions github-actions bot added this to Triage in Docs team reviews Oct 7, 2020
@janiceilene
Copy link
Contributor

@janiceilene janiceilene commented Oct 8, 2020

@casals Those two docs could definitely be better! Any thoughts about what kinds of information you think would be helpful there?

@janiceilene janiceilene added contributing docs and removed triage labels Oct 8, 2020
@janiceilene janiceilene moved this from Triage to Ecosystem in Docs team reviews Oct 8, 2020
@janiceilene janiceilene moved this from Ecosystem to Anyone in Docs team reviews Oct 8, 2020
@casals
Copy link
Contributor Author

@casals casals commented Oct 8, 2020

Sure - for specific README.md files, I think they should be as complete as possible: definitions, examples, everything that a content contributor could learn about what's being referenced (code intrincacies = negative scope).

As for CONTRIBUTING.md: IMHO it should be a complete quick start. Let's take, for instance, the last 24h: I was learning about variables, reusables, and callout tags as the PRs were reviewed. I mean, the technical detailes are there if I follow the md links, but the text doesn't give me any reasons to do so. And even if I do it, there's no clear benefit for the newcoming contributor - it reads and feels like technical documentation (which is technically not wrong, but not necessarily helpful to a newcomer as such).

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.

da-art85 added a commit to da-art85/docs that referenced this issue Oct 8, 2020
…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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.