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

Updated the docs layout, home page and FAQs #491

Merged
merged 6 commits into from
Apr 23, 2021
Merged

Conversation

ajstewart
Copy link
Contributor

@ajstewart ajstewart commented Apr 21, 2021

  • Enabled a new home page with wave design and announcement bar.
  • Changed layout to tabs and sections mode.
  • Changed location of some pages to other tab headings.
  • Added to FAQ section.

Screenshots:
Screen Shot 2021-04-21 at 21 48 46
Screen Shot 2021-04-21 at 21 48 49
Screen Shot 2021-04-21 at 21 49 08
Screen Shot 2021-04-21 at 21 49 26

- Enabled a new home page with wave design and announcement bar.
- Changed layout to tabs and sections mode.
- Changed location of some pages to other tab headings.
- Added to FAQ section.
@ajstewart ajstewart added the documentation Improvements or additions to documentation label Apr 21, 2021
@ajstewart ajstewart self-assigned this Apr 21, 2021
@ajstewart ajstewart marked this pull request as ready for review April 22, 2021 19:12
@ajstewart
Copy link
Contributor Author

@marxide I think this is also ready for review, note that I based it off #487.

The homepage has come from cannibalising other examples that I found in the mkdocs-materials issue thread on creating a similar custom homepage to what they have. It's possible that some of the css is not required but I got rid of what I could. I created some basic graphic of screenshots to go there that looks ok, it would be cool to have a proper design but I quickly realised I was out of my depth.

See what you think on the overall layout, I think the categories make sense to me but of course I'm fully open to changing whatever is necessary.

@ajstewart ajstewart requested a review from marxide April 22, 2021 19:17
Base automatically changed from docs-epoch-mode-de-ruiter-clarification to dev April 22, 2021 23:36
Comment on lines +37 to +38
<a href='/changelog/'><strong>New in version 0.3.0</strong>: Documentation, add epoch mode and more 🙌. Check the <strong>release notes!</strong></a>

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add something about updating this to the release guidelines in docs/developing/github.md?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a step in 0e60dd8

@ajstewart ajstewart requested a review from marxide April 23, 2021 18:53
@ajstewart ajstewart added this to the v0.3.0 milestone Apr 23, 2021
@ajstewart ajstewart merged commit df4ba2b into dev Apr 23, 2021
@ajstewart ajstewart deleted the docs-layout-update branch April 23, 2021 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants