search

hagenburger / pimd

PIMD – Processing Instructions for Markdown
https://hagenburger.github.io/pimd-docs/
MIT License
20 stars 5 forks source link

Sitemap for Website #33

Open violetadev opened 6 years ago

violetadev commented 6 years ago

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 commented 6 years ago

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 commented 6 years ago

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 commented 6 years ago

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