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.

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

Documentation fixes #5776

Merged
merged 3 commits into from
Oct 18, 2023
Merged

Documentation fixes #5776

merged 3 commits into from
Oct 18, 2023

Conversation

pascalwill
Copy link
Contributor

What's the problem this PR addresses?

  • Fixes documentation about docusaurus
  • Fixes links to zero-installs section
  • Fixes admonition in documentation

How did you fix it?

  • Replace links to documentation package and start script.
  • Replace /features/zero-installs with /features/caching#zero-installs. The existing global redirect only works for directly accessing the path but not the routing inside the documentation.
  • Replace :::warn with :::warning.

Checklist

  • I have set the packages that need to be released for my changes to be effective.
  • I will check that all automated PR checks pass before the PR gets reviewed.

@arcanis arcanis merged commit 26601ca into yarnpkg:master Oct 18, 2023
16 checks passed
arcanis added a commit that referenced this pull request Oct 18, 2023
**What's the problem this PR addresses?**
<!-- Describe the rationale of your PR. -->
<!-- Link all issues that it closes. (Closes/Resolves #xxxx.) -->

EDIT: I just saw that #5776 beat me to it. However, the version I
propose adds clarity imho as well as links to relevant resources.

---

The instructions in the 'Writing documentation' section gave false
information (I assume it was simply outdated), making it harder for
people to contribute.

Pls tag for Hacktoberfest.
...

**How did you fix it?**
<!-- A detailed description of your implementation. -->

* Revised the 'Writing documentation' section so that it aligns with our
current project structure
* Fixed broken links
* Provided links to the tech we use  
...

**Checklist**
<!--- Don't worry if you miss something, chores are automatically
tested. -->
<!--- This checklist exists to help you remember doing the chores when
you submit a PR. -->
<!--- Put an `x` in all the boxes that apply. -->
- [x] I have read the [Contributing
Guide](https://yarnpkg.com/advanced/contributing).

<!-- See
https://yarnpkg.com/advanced/contributing#preparing-your-pr-to-be-released
for more details. -->
<!-- Check with `yarn version check` and fix with `yarn version check
-i` -->
- [ ] I have set the packages that need to be released for my changes to
be effective.

<!-- The "Testing chores" workflow validates that your PR follows our
guidelines. -->
<!-- If it doesn't pass, click on it to see details as to what your PR
might be missing. -->
- [x] I will check that all automated PR checks pass before the PR gets
reviewed.

Co-authored-by: Maël Nison <nison.mael@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants