-
Notifications
You must be signed in to change notification settings - Fork 30k
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
doc: spruce up user journey to local docs browsing #34986
Conversation
This patch improves the means by which the docs are viewed locally. * Remove extraneous code in the `docserve` Makefile target * Document the `docserve` task for all to know * Bring all code snippets in this section up to speed * Clarify the purpose of each documentation browsing method Fixes: #34977
Welp, not much of a diff anymore in light of #34977 (comment), but this does indeed work on my machine for some reason and speculate that it's due to having run |
Line 1 in e1edd6b
|
Codecov Report
@@ Coverage Diff @@
## master #34986 +/- ##
==========================================
+ Coverage 96.67% 96.69% +0.01%
==========================================
Files 208 207 -1
Lines 68993 69126 +133
==========================================
+ Hits 66701 66841 +140
+ Misses 2292 2285 -7
Continue to review full report at Codecov.
|
This comment has been minimized.
This comment has been minimized.
@mmarchini, I've clarified the prose a bit, PTAL. |
There's still some sort of a bug here. It's not working as I would expect. I should be able to run: make docclean
make docserve However, instead, I get this error:
This is evidence that #34986 (comment) needs to be addressed first. |
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
This patch improves the means by which the docs are viewed locally. * Remove extraneous code in the `docserve` Makefile target * Document the `docserve` task for all to know * Bring all code snippets in this section up to speed * Clarify the purpose of each documentation browsing method Fixes: #34977 PR-URL: #34986 Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Landed in ff0aad0 |
This patch improves the means by which the docs are viewed locally. * Remove extraneous code in the `docserve` Makefile target * Document the `docserve` task for all to know * Bring all code snippets in this section up to speed * Clarify the purpose of each documentation browsing method Fixes: #34977 PR-URL: #34986 Reviewed-By: Richard Lau <riclau@uk.ibm.com>
This patch improves the means by which the docs are viewed locally. * Remove extraneous code in the `docserve` Makefile target * Document the `docserve` task for all to know * Bring all code snippets in this section up to speed * Clarify the purpose of each documentation browsing method Fixes: #34977 PR-URL: #34986 Reviewed-By: Richard Lau <riclau@uk.ibm.com>
This patch improves the means by which the docs are viewed locally. * Remove extraneous code in the `docserve` Makefile target * Document the `docserve` task for all to know * Bring all code snippets in this section up to speed * Clarify the purpose of each documentation browsing method Fixes: #34977 PR-URL: #34986 Reviewed-By: Richard Lau <riclau@uk.ibm.com>
This patch improves the means by which the docs are viewed locally. * Remove extraneous code in the `docserve` Makefile target * Document the `docserve` task for all to know * Bring all code snippets in this section up to speed * Clarify the purpose of each documentation browsing method Fixes: #34977 PR-URL: #34986 Reviewed-By: Richard Lau <riclau@uk.ibm.com>
This patch improves the means by which the docs are viewed locally. * Remove extraneous code in the `docserve` Makefile target * Document the `docserve` task for all to know * Bring all code snippets in this section up to speed * Clarify the purpose of each documentation browsing method Fixes: nodejs#34977 PR-URL: nodejs#34986 Reviewed-By: Richard Lau <riclau@uk.ibm.com>
This patch improves the means by which the docs are viewed locally.
docserve
Makefile targetdocserve
task for all to knowFixes: #34977