Documentation Restructure #729
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
@curquiza Would you like to contribute an introduction paragraph for sdks.md? In the preview, you can find this page by going to Learn -> What Is MeiliSearch -> SDKs |
Contributor
Author
|
Note: Netlify preview appears to be having some problems, consider cloning the branch and doing a |
Member
hum, I like yours in "What is MeiliSearch?" main page -> |
dichotommy
force-pushed
the
restructure
branch
from
621c9e2 to
999e023
Compare
Explanation of new documentation sections
Moved quick start guide and what's next into new Learn directory
Moved contents of /guides/main_concepts/ into /learn/core_concepts/
Moved /guides/introduction/README.md into /learn/learn_meilisearch/. Added some content.
Moved contents of resources/howtos/ into create/how_to/. Added content to that folder's README.md
Moved /references/* to /reference/api/
Moved several files from /guides/advanced_guides/ into /reference/under_the_hood/
Moved stop_words.md, datatypes.md, asynchronous_updates.md, and about_storage.md into reference/under_the_hood/
Move guides/advanced_guides/* to reference/features
Moved contact.md and sdks.md into learn/. Also deleted resources/tutorials/README.md and improved learn/learn_meilisearch/README.md
Made new dir learn/what_is_meilisearch/, moved sdks.md and comparison_to_alternatives.md there
Created new folder learn/elevate -- represents section tentatively titled Elevate Your Understanding, with clarifications on features such as dumps vs. snapshots, facets vs. filters, etc.
Create /learn/README.md and add 'What is MeiliSearch' to the Learn sidebar
Add Learn MeiliSearch, Core Concepts, and Elevate Your Understanding to the Learn sidebar. Improve learn/core_concepts/README.md
Create reference sidebar (categories: Feature References; API References; Under the Hood), create READMEs for /reference/, /reference/features/, /reference/under_the_hood
Add Create sidebar to config.js (only one section for the moment: How To), add /create/README.md
And delete learn/core_concepts/search.md
Language info moved into Learn section (under Advanced Topics); tokenization info moved into Under the Hood
Remove reference to Crisp chat from contact.md
Improve reference READMEs, rename about_storage.md to just storage.md
dichotommy
force-pushed
the
restructure
branch
from
999e023 to
94a540e
Compare
fharper
approved these changes
Feb 2, 2021
Contributor
fharper
left a comment
fharper
left a comment
There was a problem hiding this comment.
That is some very good work there! Good job @react-learner
LGTM
Member
|
You made an awesome job!! 😁 |
dichotommy
added a commit
that referenced
this pull request
Feb 2, 2021
This reverts commit 32d957b.
Contributor
Author
|
This did not work, caused the same error as can be seen in the Netlify deploy preview. Strange, as there's no error with local VuePress builds. Must be something on Netlify's end, or else... the scraper? 🤔 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Final to do before merging:
Future planned improvements (not in this PR):
Would like feedback on:
Closes #634 , closes #619