Skip to content
This repository has been archived by the owner on Jan 8, 2019. It is now read-only.

Direct link to documentation in a prominent place #66

Open
MartinHelmut opened this issue Jan 12, 2018 · 2 comments · May be fixed by #67
Open

Direct link to documentation in a prominent place #66

MartinHelmut opened this issue Jan 12, 2018 · 2 comments · May be fixed by #67

Comments

@MartinHelmut
Copy link

Hey,

one of the thinks I got as a feedback from people looking at the alva website is that there is no way to get more information and documentation, like an "how to do stuff". This could easily be solved by linking to the Github repository documentation but should be separated by three parts, e.g.:

  • How to use it as a Designer
  • What to know for Developers
  • I want to contribute, but how

So everyone looking for informations and entering your website (some of them without knowledge what Github is) can find there way to start working with alva.

@markusoelhafen
Copy link
Member

Hey,

good point! We're already thinking to implement something like an FAQ and Getting started guide for both designers and developers.
Linking to the git documentation would be a nice and simple first implementation, but should be extended later on.

@lucoel
Copy link
Member

lucoel commented Jan 15, 2018

before introducing a more complex guide the readme is the only documentation, isn't it?

lucoel added a commit that referenced this issue Jan 15, 2018
@lucoel lucoel linked a pull request Jan 23, 2018 that will close this issue
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants