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

Pattern: Docs layout #1991

Closed
nottrobin opened this issue Sep 17, 2018 · 4 comments
Closed

Pattern: Docs layout #1991

nottrobin opened this issue Sep 17, 2018 · 4 comments

Comments

@nottrobin
Copy link
Contributor

nottrobin commented Sep 17, 2018

https://docs.vanillaframework.io uses a layout which has a left sidebar and a right content area.

https://docs.staging.snapcraft.io/ uses something very similar, but squeezed to max-width: 64.875rem. Hopefully, down the line these two will be unified, and will become the standard for all docs.

The latter I've turned into a new layout component called l-docs. Maybe we might want to consider making this an official part of the Vanilla?

@kwm14
Copy link
Contributor

kwm14 commented Oct 15, 2018

Agreed in WG

  • we need to understand why you've done it this way
  • will discuss in the next WG when your here

@nottrobin
Copy link
Contributor Author

nottrobin commented Nov 12, 2018

Actions (from WG):

  • Port documentation layout styles from docs.vanillaframework.io into Vanilla core, such that docs.vanillaframework.io has no custom styles (@deadlight to create issues)
  • Carry out an investigation into top navigation width, to decide whether snapcraft.io, www.ubuntu.com are allowed to be different from e.g. maas.io (@spencerbygraves to check with @clagom)
  • Conclude discussion about documentation landing pages - is it okay to have custom, "pretty" landing pages in front of documentation that is otherwise generated from Discourse (discussion started on snapcraft forum) (@matthewpaulthomas to follow-up)
  • Decide whether documentation sites should be full width, or constrained width, or both (@kwm14 to investigate)

@deadlight
Copy link
Contributor

Issue created: #2049

@kwm14 kwm14 removed the WG: Proposal Working group proposals label Nov 19, 2018
@bartaz
Copy link
Member

bartaz commented May 5, 2020

Documentation layout work is in progress and tracked elsewhere (#2681 )

@bartaz bartaz closed this as completed May 5, 2020
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

4 participants