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

Mc/sandbox docs skeleton #1172

Merged
merged 2 commits into from
Jul 25, 2023
Merged

Mc/sandbox docs skeleton #1172

merged 2 commits into from
Jul 25, 2023

Conversation

iAmMichaelConnor
Copy link
Contributor

@iAmMichaelConnor iAmMichaelConnor commented Jul 24, 2023

Description

  • Introduce a suggestion for the docs directory structure.
  • Introduce a 'preprocessor' macro which enables code from the codebase to be injected as a code snippet into the docs, before docusaurus builds the docs.
  • Wrote some actual docs.

Checklist:

  • I have reviewed my diff in github, line by line.
  • Every change is related to the PR description.
  • I have linked this pull request to the issue(s) that it resolves.
  • There are no unexpected formatting changes, superfluous debug logs, or commented-out code.
  • The branch has been merged or rebased against the head of its merge target.
  • I'm happy for the PR to be merged at the reviewer's next convenience.

@netlify
Copy link

netlify bot commented Jul 24, 2023

Deploy Preview for preeminent-bienenstitch-606ad0 ready!

Name Link
🔨 Latest commit e5ce2d7
🔍 Latest deploy log https://app.netlify.com/sites/preeminent-bienenstitch-606ad0/deploys/64bfce349a3265000891a037
😎 Deploy Preview https://deploy-preview-1172--preeminent-bienenstitch-606ad0.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 configuration.

@iAmMichaelConnor
Copy link
Contributor Author

^^^ I have no idea how Netlify was able to deploy anything, because I rugged the /docs/docs/ file... There is no /docs/docs/ file from which it can build? Is it clever enough to know to use /docs/draft-docs/? Surely not?

@critesjosh
Copy link
Contributor

critesjosh commented Jul 25, 2023

Netlify runs yarn build then serves whatever is in docs/build. It looks like yarn build runs your preprocessor which, from what I understand, populates the docs/docs dir--and then builds from docs/docs.

"build": "yarn preprocess && docusaurus build",

@iAmMichaelConnor iAmMichaelConnor force-pushed the mc/sandbox-docs-skeleton branch from fd7fc0b to e5ce2d7 Compare July 25, 2023 13:29
@iAmMichaelConnor iAmMichaelConnor marked this pull request as ready for review July 25, 2023 13:31
@iAmMichaelConnor iAmMichaelConnor merged commit abb6197 into master Jul 25, 2023
@iAmMichaelConnor iAmMichaelConnor deleted the mc/sandbox-docs-skeleton branch July 25, 2023 14:37
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