docs: fix parity with online docs #839
Merged
Conversation
This file contains 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
Primary motivation for this change, was /issues/836. As discussed there, there were broken links. In the process of fixing those links, parity between what the site looked like and the file structure of the source code was brought closer in line. One thing to note, is paradedb/paradedb/commit/68ed49bc193926976b7f5afb1b0e6f0201dae41c This is where the deprecated docs were deleted. In that process, the link to it is no longer valid. Some liberties were needed to be made, to make the deprecated page still make sense docs(prettier): update prettier ignore settings New doc pages have new paths. Updates those paths in `.prettierignore` for the pre-commit stage
|
|
To prevent /issues/836 (broken links) from happening in the future, a CI step is recommended. This pre-commit *should* prevent it from causing issues again.
|
As per ecb1fec, I added a CI step into the pre-commits. I hope it helps and you guys like it. |
philippemnoel
approved these changes
Feb 13, 2024
Merged
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.
What
Primary motivation for this change, was /issues/836. As discussed there, there were broken links. In the process of fixing those links, parity between what the site looked like and the file structure of the source code was brought closer in line.
One thing to note, is paradedb/paradedb/commit/68ed49bc193926976b7f5afb1b0e6f0201dae41c This is where the deprecated docs were deleted. In that process, the link to it is no longer valid. Some liberties were needed to be made, to make the deprecated page still make sense
docs(prettier): update prettier ignore settings
New doc pages have new paths. Updates those paths in
.prettierignorefor the pre-commit stageTicket(s) Closed
Why
As discussed in #836 , there were broken links in the docs. Upon further investigation, the whole doc source was never cleaned up since the recent reworks. This PR aims to clean up and lower the discrepancies hosted docs and their source code.
How
Updates links and creates new directories.
.prettierignorewas also updated.Created directories:
docs/full-text/docs/hybrid/docs/similarity/Tests
N/A