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

website layout, organization, and navigation #325

Closed
1 of 5 tasks
thescientist13 opened this issue Apr 11, 2020 · 5 comments
Closed
1 of 5 tasks

website layout, organization, and navigation #325

thescientist13 opened this issue Apr 11, 2020 · 5 comments
Assignees
Labels
website Tasks related to the projects website / documentation
Milestone

Comments

@thescientist13
Copy link
Member

Type of Change

  • New Feature Request
  • Documentation / Website
  • Improvement / Suggestion
  • Bug
  • Other (please clarify below)

Summary

As we plan to grow the website with more content and updates, like

We should think if there any sitewide changes / redesigns we would want to take.

Details

TBD

@thescientist13
Copy link
Member Author

This might be a helpful resource on the topic

@thescientist13 thescientist13 added the website Tasks related to the projects website / documentation label Apr 11, 2020
@thescientist13 thescientist13 added this to the MVP milestone Apr 11, 2020
@thescientist13
Copy link
Member Author

should also absorb #278 and #268 ?

@thescientist13
Copy link
Member Author

Stripe docs are pretty next level 🤯

@thescientist13 thescientist13 self-assigned this Nov 7, 2020
@thescientist13
Copy link
Member Author

thescientist13 commented Dec 22, 2020

Had some thoughts on layout / structure

  • Rename
    • Menu -> Collections / Groups
    • Templates -> Layouts (make docs file naming consistent as well)
    • page.html -> default.html
    • devServer -> server
  • Sort docs/ side nav better?
    • I think it should be progressive in sequence of need to know. Right now it jumps right into component model, but maybe should go from least to most advanced? e.g. go from Build -> Layouts -> Markdown -> FM -> Components -> Styles -> etc (flow through a general order of
    • Or should either be alpha sorted?
  • Formatting for guides should have consistent structure / format
  • Add dedicated examples on content authoring, e.g. static vs dynamic
    • pages are just components, right?
    • dynamic as a "page" tag in the template HTML (markdown can be empty!)
    • dynamic as a "page" tag in the markdown

@thescientist13
Copy link
Member Author

will be carried out in a discussion first in #503

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
website Tasks related to the projects website / documentation
Projects
None yet
Development

No branches or pull requests

1 participant