Skip to content
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.

Sign up for GitHub

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

Update Docusaurus to 3.6.3 #588

Merged
merged 4 commits into from
Dec 9, 2024
Merged

Update Docusaurus to 3.6.3 #588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b819cff
Update Docusaurus to 3.6.3
Staudey Dec 9, 2024
dfeca59
Enable Docusaurus Faster
Staudey Dec 9, 2024
dd0386f
Remove unused Babel file to fix a warning
Staudey Dec 9, 2024
9d4fd3a
Fix build warnings due to generating nested <p> tags
Staudey Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions babel.config.js
View file
Open in desktop

This file was deleted.

24 changes: 6 additions & 18 deletions docs/packaging/submitting-a-pull-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,43 +47,31 @@ There are multiple ways to create a pull request with GitHub, either from the we

<Tabs groupId="opening-prs">
<TabItem value="website" label="Website">
<p>
In the package folder, push your local changes to a remote branch:

<p>In the package folder, push your local changes to a remote branch:</p>
<CodeBlock language="bash">
git push
</CodeBlock>
</p>
<Admonition type="info">
If you've created your own branch, as recommended, the CLI tool will show you a new command to create and push to a remote branch matching the local one. Run this.
</Admonition>
<p>
Once the commit is successfully pushed, you'll notice that a URL will be provided that will immediately allow you to create a pull request with your changes.

Run `git status` one last time to make sure your branch is clean. If it is:

<p>Once the commit is successfully pushed, you'll notice that a URL will be provided that will immediately allow you to create a pull request with your changes.</p>
<p>Run `git status` one last time to make sure your branch is clean. If it is:</p>
1. Open the link.
2. Fill in a summary of your changes (usually the same as the commit message).
3. Link any relevant issues:
- If you want to link this pull request to an existing issue, simply mention it in the PR summary: `The inclusion of <somepackage> fixes #123`.
- If you need a change to depend on another change, mention it in the PR summary too: `Depends on #234`.
4. Double-check everything.
5. Create the pull request!
</p>

</TabItem>
<TabItem value="github-cli" label="GitHub CLI">
<p>
In the package folder, run the `gh` command:
</p>
<p>In the package folder, run the `gh` command:</p>
<CodeBlock language="bash">
gh pr create
</CodeBlock>
<p>
This will start an interactive session to create your pull request step-by-step.

When the current branch isn't fully pushed to a git remote, a prompt will ask where to push the branch and offer an option to fork the base repository. For community packagers, you should use your fork of the packages repository. If you are a member of the Solus Staff, you should use `getsolus/packages`.
</p>
<p>This will start an interactive session to create your pull request step-by-step.</p>
<p>When the current branch isn't fully pushed to a git remote, a prompt will ask where to push the branch and offer an option to fork the base repository. For community packagers, you should use your fork of the packages repository. If you are a member of the Solus Staff, you should use `getsolus/packages`.</p>
<Admonition type="info">
The text editor used by `github-cli` may not the same one that `git` uses. To change this, consult the [`gh config set` command](https://cli.github.com/manual/gh_config_set).
</Admonition>
Expand Down
5 changes: 5 additions & 0 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ const config = {
locales: ["en"],
},

// Enable Docusaurus Faster
future: {
experimental_faster: true,
},

presets: [
[
"classic",
Expand Down
11 changes: 6 additions & 5 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@
},
"dependencies": {
"@cmfcmf/docusaurus-search-local": "^1.2.0",
"@docusaurus/core": "3.5.2",
"@docusaurus/plugin-ideal-image": "3.5.2",
"@docusaurus/preset-classic": "3.5.2",
"@docusaurus/core": "3.6.3",
"@docusaurus/faster": "^3.6.3",
"@docusaurus/plugin-ideal-image": "3.6.3",
"@docusaurus/preset-classic": "3.6.3",
"@emotion/react": "^11.11.1",
"@emotion/styled": "^11.11.0",
"@mdx-js/react": "^3.0.0",
Expand All @@ -34,8 +35,8 @@
"react-dom": "^18.2.0"
},
"devDependencies": {
"@docusaurus/eslint-plugin": "3.5.2",
"@docusaurus/module-type-aliases": "3.5.2",
"@docusaurus/eslint-plugin": "3.6.3",
"@docusaurus/module-type-aliases": "3.6.3",
"@tsconfig/docusaurus": "^2.0.0",
"@typescript-eslint/eslint-plugin": "^5.61.0",
"@typescript-eslint/parser": "^5.61.0",
Expand Down
Loading
Loading