Skip to content

Fix #1131: Document homepage active link pitfall #1174

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 1 commit into from
May 15, 2020

Conversation

zhouzi
Copy link
Contributor

@zhouzi zhouzi commented May 12, 2020

Summary

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

The first place I went to when noticing this issue was the documentation for the homepage. So that's where I thought it was best to document it.

I'm not a big fan of documenting pitfalls this way though. The list tends to grow with everyone's reports, which are often tied to a very specific use case.

With that being said, I feel like this issue is likely to affect a lot of users but I am new to docsify so I can be totally wrong.

I would be happy to have your opinion and it's fine by me if this PR is rejected.


  • DO NOT include files inside lib directory.

Closes #1131

@anikethsaha anikethsaha reopened this May 14, 2020
Copy link
Member

@anikethsaha anikethsaha left a comment

Choose a reason for hiding this comment

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

can you change your commit message formatting.

use this guideline

to change the message, use amend, git commit --amend and after changing the commit message do a force push

@anikethsaha anikethsaha merged commit aad80f9 into docsifyjs:develop May 15, 2020
@anikethsaha
Copy link
Member

thanks

@zhouzi zhouzi deleted the patch-1 branch May 15, 2020 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Visiting homepage doesn't set homepage link in sidebar to active
2 participants