Skip to content

Move the migration and contribution guidelines in separate sections #699

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

Merged
merged 2 commits into from
Nov 19, 2020

Conversation

NataliaTepluhina
Copy link
Member

@NataliaTepluhina NataliaTepluhina commented Nov 18, 2020

Description of Problem

Currently, the Migration Guide and Contribute to the Docs section are nested in the sidebar under the first docs section (Guide). Here're are some minor issues caused by this nesting:

  1. Navigation: When you click the Migration Guide link from the Docs dropdown menu, the sidebar is not scrolling to the relevant section which could cause confusion. For example, if you're on the top of the Template refs section and then click on the Migration Guide from the Docs dropdown, it's not clear there's a list of relevant sub-sections you can navigate to.
  2. Copy: The Docs dropdown is repeatedly using the Guide keyword in the dropdown options.
  3. Discoverability: It's hard to locate contribution guidelines.

Proposed Solution

  1. Move the migration and contribution guidelines in separate top-level sections with their own sidebar.
  2. Update the Docs dropdown with something like the following (see screenshots).

Please check deployed preview here

@NataliaTepluhina NataliaTepluhina added the style-improvement Related to theme design and/or ux label Nov 18, 2020
migration: [
'/guide/migration/introduction',
{
title: 'Details',
Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure this is the best name but we need something to wrap 'detailed changes'

Copy link
Contributor

@skirtles-code skirtles-code left a comment

Choose a reason for hiding this comment

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

Looks good.

@NataliaTepluhina NataliaTepluhina merged commit 1acbe28 into master Nov 19, 2020
nick-lai pushed a commit to nick-lai/docs-next that referenced this pull request Dec 2, 2020
…uejs#699)

* fix: changed sidebar to separate migration guide

* fix: moved contribute section
@NataliaTepluhina NataliaTepluhina deleted the separate-migration-guide-sidebar branch February 24, 2021 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
style-improvement Related to theme design and/or ux
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move the migration and contribution guidelines in separate sections
2 participants