-
Notifications
You must be signed in to change notification settings - Fork 394
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: adds Docusaurus site #2174
Merged
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2174 +/- ##
=======================================
Coverage 82.07% 82.07%
=======================================
Files 18 18
Lines 1545 1545
Branches 443 443
=======================================
Hits 1268 1268
Misses 179 179
Partials 98 98 ☔ View full report in Codecov by Sentry. |
filmaj
approved these changes
Jul 29, 2024
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.
LGTM! Left a few notes/questions but overall looks great!
…the color of vscode windows specifically because otherwise you end up like luke committing to the wrong repo
This was referenced Sep 5, 2024
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.
Summary:
This is the new Docusaurus site. Tested that it builds properly. (You can confirm by looking at the Test Deployment test below.) Is that a bad test name? Writing that sentence makes it seem so.
This is less absurdly large then it looks! ~16,000 of the changed lines are
package-lock.json
😬 . 84 of the changed files are the same markdown files re-formatted and moved. (I did a comical amount ofgit mv
so all history is still intact). And I deleted about 30 files.Folder and file organization
This shares the same structure as the other sites. At large:
The default name for my
content
folder wasdocs
butdocs/docs
was silly. I am open to other names though.Docs pages: slugs and links
The organization of pages is purposefully kept as similar to the current layout of pages so developers don't get jarred from both a site change and page changes. Slugs are all named matching that previous organization - i.e. something in the
basics
or theadvanced
folder (and others) has theconcepts
slug:/bolt-js/concepts/authorization
. This is slightly different than the previous site, which took the form of/bolt-js/concepts#authorization
. They're all separate pages, not headers now. I've written a script to redirect the oldconcepts#topic
to the properconcepts/topic
. Any previous working link will properly redirect.All
.md
files were renamed (yes, I usedgit mv
) to match the title and the slug. Everything now matches up.All markdown reference links were also updated to be up-to-date and working. If it's a link on the site, it now works. I also stripped all the pages of any residual HTML or custom formatting. They should all be the most basic of markdown now.
Editing and managing the site
The README contains a basic docs editing guide. You don't need to worry about the site unless you're touching something inside the
/docs
folder.There is a new action workflows: it does a test build on docs PRs and deploys the site on merges to main.
Next steps
This wouldn't be a DevRel project without some fast follows. This is what I plan on doing after all the sites are live:
custom.css
if the main site'scustom.css
is changed./
just redirects to/getting-started
since that's all this site had.Requirements