-
-
Notifications
You must be signed in to change notification settings - Fork 5.7k
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
docs: Improve Quick start instructions #1466
base: develop
Are you sure you want to change the base?
Conversation
- Slightly tweak Python server instructions to be more generic - Clarify the section about customizing the main container
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/FoXf6KR51FL2kQTQotT831h1RVKP |
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit db63e37:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thx.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that last part maybe should be kept, and be "See the el
option"?
About the snippet mentioning python, we should probably replace that with instructions on docsify CLI or just use the tools we already have for managing Docsify, like Node/npm and Otherwise we're mentioning a tool that isn't related to Docsify, and we're not documenting that. We're all using Node/npm to develop and consume Docsify. |
I added that link right above the code sample, which is why I removed that line. Adding it immediately below again would be redundant, and potentially even confusing IMO (I would have assumed it to be a typo or overlook of some kind). If you prefer it at the bottom, then I'd suggest not linking "configure" in the mention above the code sample, which would justify the line below with the link. What do you think? |
docsify-cli is included in the previous content, python is another way. |
@trusktr you have some requested change. Is it good to review or still needs to be addressed ? |
I responded to his comment with some considerations and proposed alternatives. I am happy to make changes once there's agreement on how to proceed. |
Summary
Re-submission of #1458, this time targeting the correct branch :)
What kind of change does this PR introduce? (check at least one)
If changing the UI of default theme, please provide the before/after screenshot:
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
fix #xxx[,#xxx]
, where "xxx" is the issue number)You have tested in the following browsers: (Providing a detailed version will be better.)
If adding a new feature, the PR's description includes:
To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.