-
-
Notifications
You must be signed in to change notification settings - Fork 8.8k
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(v2): add section for docs-only mode #2378
Conversation
Hi @phoqe! Thank you for your pull request and welcome to our community.We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
Deploy preview for docusaurus-2 ready! Built with commit abeec31 |
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 am not against such additions, although it might be worth considering creating a new section for such issues, something like FAQ or Troubleshooting, to keep the pages as clean as possible.
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks! |
@lex111 Yes, it feels like this section is a bit misplaced but there was no better place to put it since the info about the docs is a category and not a single page. Could maybe be a worthwhile mention in the setup for people that only want to use Docusaurus for the 'documentation' feature. |
Co-Authored-By: Alexey Pyltsyn <[email protected]>
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks! |
By the way, it appears that using only that code snippet and removing the pages altogether will results in a 404. It seems that it's required to have a index.js with a |
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.
Nice, thank you!
Motivation
There's information on a Blog-only mode but there's none for a Docs-only mode. The same principle applies, and are documented in this documentation addition.
Have you read the Contributing Guidelines on pull requests?
Yes