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

docs: mention equivalent config syntaxes #8951

Merged
merged 10 commits into from
May 5, 2023

Conversation

thadguidry
Copy link
Contributor

@thadguidry thadguidry commented Apr 29, 2023

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

Fixes part of #8925

Test Plan

Test links

https://deploy-preview-8951--docusaurus-2.netlify.app/docs/configuration/#syntax-to-declare-docusaurus-config

https://deploy-preview-8951--docusaurus-2.netlify.app/docs/api/docusaurus-config/

Related issues/PRs

#8925

@netlify
Copy link

netlify bot commented Apr 29, 2023

[V2]

Name Link
🔨 Latest commit 2cd9b4e
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/6454ce311ec6d600080e2412
😎 Deploy Preview https://deploy-preview-8951--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

github-actions bot commented Apr 29, 2023

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟢 95 🟢 97 🟢 92 🟢 100 🟠 89 Report
/docs/installation 🟠 84 🟢 100 🟢 92 🟢 100 🟠 89 Report

website/docs/api/docusaurus.config.js.mdx Outdated Show resolved Hide resolved
website/docs/configuration.mdx Outdated Show resolved Hide resolved
@slorber slorber marked this pull request as draft May 3, 2023 16:47
website/docs/configuration.mdx Outdated Show resolved Hide resolved
website/docs/configuration.mdx Outdated Show resolved Hide resolved
website/docs/configuration.mdx Outdated Show resolved Hide resolved
website/docs/configuration.mdx Outdated Show resolved Hide resolved
@thadguidry thadguidry marked this pull request as ready for review May 5, 2023 02:11
@thadguidry
Copy link
Contributor Author

To me, this now looks and feels really good. The missing info and examples that would have simply explained things for me at the very beginning of my confusion and opening issue #8925. I hope it now matches all our expectations for more clear docs for novice users trying out Docusaurus for the first time.

@slorber so, what do you think now?

@slorber
Copy link
Collaborator

slorber commented May 5, 2023

Thanks, will do some minor edits and merge

@slorber slorber changed the title Info-about-init-template docs: mention equivalent config syntaxes May 5, 2023
@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label May 5, 2023
@slorber slorber merged commit fb4a5fb into facebook:main May 5, 2023
@thadguidry thadguidry deleted the info-about-init-template branch May 5, 2023 10:45
This was referenced Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants