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: add page for create-docusaurus API documentation #7343

Merged
merged 2 commits into from
May 5, 2022

Conversation

Josh-Cena
Copy link
Collaborator

@Josh-Cena Josh-Cena commented May 5, 2022

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

Our create-docusaurus CLI is getting increasingly complex. Let's have a dedicated API documentation page for all options. This will also help us put less text in the installation guide, which is supposed to be brief.

Test Plan

Test links

Deploy preview: https://deploy-preview-7343--docusaurus-2.netlify.app/docs/api/misc/create-docusaurus/

@Josh-Cena Josh-Cena added the pr: documentation This PR works on the website or other text documents in the repo. label May 5, 2022
@Josh-Cena Josh-Cena requested review from slorber and lex111 as code owners May 5, 2022 11:15
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label May 5, 2022
@netlify
Copy link

netlify bot commented May 5, 2022

[V2]

Name Link
🔨 Latest commit 0cb1d53
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/6273b4a59ceb92000b3901d2
😎 Deploy Preview https://deploy-preview-7343--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 May 5, 2022

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 70 🟢 100 🟢 100 🟢 100 🟢 90 Report
/docs/installation 🟢 91 🟢 99 🟢 100 🟢 100 🟢 90 Report

@Josh-Cena Josh-Cena merged commit 0cc4fa8 into main May 5, 2022
@Josh-Cena Josh-Cena deleted the jc/create-docusaurus branch May 5, 2022 11:36
@slorber
Copy link
Collaborator

slorber commented May 5, 2022

not sure why but it fails the fr build 🤷‍♂️

2:18:10 PM: - On source page path = /fr/docs/next/installation:
2:18:10 PM: -> linking to ./api/misc/create-docusaurus.md (resolved as: /fr/docs/next/api/misc/create-docusaurus.md)
2:18:10 PM:

@Josh-Cena
Copy link
Collaborator Author

Yes, I also noticed this😅 Everything is looking fine on Crowdin, though

@Josh-Cena Josh-Cena added pr: documentation This PR works on the website or other text documents in the repo. and removed pr: documentation This PR works on the website or other text documents in the repo. labels May 11, 2022
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.

3 participants