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

Sitemap for Website #33

Open
violetadev opened this issue Aug 18, 2018 · 3 comments
Open

Sitemap for Website #33

violetadev opened this issue Aug 18, 2018 · 3 comments
Labels
documentation enhancement New feature or request
Milestone

Comments

@violetadev
Copy link
Collaborator

violetadev commented Aug 18, 2018

It would be nice to re-structure the website so people can understand faster what LSG is about and find documentation to start working with it.

Here is a first idea:

  1. Home
  2. About
    2.1 What is LSG
    2.2 FAQ
    2.3 Code of Conduct
  3. Documentation
    3.1 Install
    3.2 Plugins
    3.3 Integration
    3.4 API
    3.5 Writing the Style Guide
    3.6 Examples
  4. Examples
  5. Blog
  6. Get Involved

mf169786adbe29ba4e65dd192281c3ac21534625173270

@hagenburger hagenburger added enhancement New feature or request documentation labels Aug 18, 2018
@hagenburger hagenburger added this to the v1.0.0 milestone Aug 18, 2018
@hagenburger
Copy link
Owner

That sounds pretty good!

The content of the start page needs to be defined. I think we should try to put the live demo right there to explain the advantages.

How would we collect the questions for the FAQ?

The blog needs to be added.

@violetadev
Copy link
Collaborator Author

Homepage: sounds good. We can add a news (twitter feed?) and a blog widgets. And some icons like you have now with open issues, link to the repo, etc.
Maybe we can switch the subpage Live Demo to "Examples", adding some screenshots and a repo for people to try it out.
FAQ: mmhh I'm not sure how to collect the questions. Let me look into the other sites FAQs and maybe I'll come up with something. Also I have been talking to a lot of devs about the project and showing them the repo and the usual questions were: what does this do? what's the difference with a static living style guide? what functionalities does it have?

@hagenburger
Copy link
Owner

Those questions are good to start. Great that you already collected them from your colleagues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants