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

The documentation is confusing for people who aren't familiar with GH #296

Open
deniak opened this issue May 24, 2016 · 1 comment
Open

Comments

@deniak
Copy link
Member

deniak commented May 24, 2016

A few people complained about the documentation not being clear or easy to read. From the different comments, it seems the different notions (travis, webhook, tokens, etc) are too complex and shouldn't be mixed altogether.
One idea is to create 2 types of docs: beginners and advanced:

  • beginners:
    • how to create a token
    • how to submit a tar or a url
  • advanced:
    • manifests for compound documents
    • GH + travis (single spec per repo, multiple specs in one repo)
    • respec documents and what spec-generator is actually doing
    • upcoming support from bikeshed
@deniak deniak self-assigned this May 24, 2016
@tripu
Copy link
Member

tripu commented May 26, 2016

In the long term, I prefer to have documentation on the Specberus/Echidna web pages themselves (and discard the GH wiki). It will allow us to structure things better, embed other content, etc. And it will be more consistent with the rest of the tools.

(Not to say I disagree with what you wrote; I'm just mentioning this to decide whether we'll continue extending the wiki, or start writing documentation on pages that will be served in the future at https://labs.w3.org/echidna/help/, or something like that. I prefer the latter.)

@deniak deniak removed their assignment Sep 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants