[improve][doc] improve doc and fix errors - #18860
Conversation
github-actions
Bot
added
the
doc
tisonkun
changed the title
| --- | ||
| Id: how-to-landing | ||
| title: How-to | ||
| sidebar_label: “” | ||
| title: How to landing | ||
| sidebar_label: "How to landing" | ||
| --- |
There was a problem hiding this comment.
I think this is a landing page that intends to use this title. Please revert these changes.
There was a problem hiding this comment.
Yes, it's a landing page for a serial of how-to topics.
There was a problem hiding this comment.
Does sidebar_label: “” need to revert?
There was a problem hiding this comment.
@labuladong you can change it to sidebar_label: "" but actually Docu recognizes both " and “.
There was a problem hiding this comment.
😂 Seems sidebar_label must be “”. if I change it to "", error occurs:
There was a problem hiding this comment.
It's a very tricky way to avoid this error. I'm not sure of the reason, I'm reverting it for now.
There was a problem hiding this comment.
I believe you can remove the sidebar_label at all. Since these pages don't show in the sidebar.
There was a problem hiding this comment.
I suggest keeping this field. I guess it's very likely that they will appear in the sidebar soon or later :)
There was a problem hiding this comment.
I've tested, remove sidebar_label: “” works fine. I think removing it is better because using“” is too tricky and not a good practice in the document.
they will appear in the sidebar soon or later.
We can just add it at any time if we need it.
a587d42 to
a6e3c80
Compare
tisonkun
left a comment
tisonkun
left a comment
There was a problem hiding this comment.
Thanks for your contribution @labuladong!
Merging...
3 participants
Modifications
Most modification is style improvement and obvious error fix.
The notable changes are in
debug function with localrun mode:Add
-originalandprotobufdependency. If not, the localrun function cannot start.Documentation
docdoc-requireddoc-not-neededdoc-complete