Skip to content
This repository has been archived by the owner on Feb 2, 2023. It is now read-only.

Update docs to include examples #47

Merged
merged 10 commits into from
Sep 26, 2022

Conversation

Racer159
Copy link
Contributor

@Racer159 Racer159 commented Aug 22, 2022

Update the docs site to include the updated examples. (Note Edit this page currently references master so some pages will not exist until merging zarf-dev/zarf#681)

Fixes: #7 #46 #50

@netlify
Copy link

netlify bot commented Aug 22, 2022

Deploy Preview for zarf-docs ready!

Name Link
🔨 Latest commit 653217a
🔍 Latest deploy log https://app.netlify.com/sites/zarf-docs/deploys/6307d4f88627bd00099107ab
😎 Deploy Preview https://deploy-preview-47--zarf-docs.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.

@Racer159 Racer159 mentioned this pull request Aug 22, 2022
.gitmodules Outdated Show resolved Hide resolved
@Racer159
Copy link
Contributor Author

Note that we are pulling in all .md files now which has the following side effects:

Building the site takes a little bit longer (Con)
Docusaurus will error out on any bad link or markdown syntax error to tell us to update them (Pro)
We can import documents from anywhere in the repo (like the CONTRIBUTING.md file) (Pro)

@Madeline-UX
Copy link
Collaborator

@Racer159 I have some feedback to add. Can we tag up to discuss a few design things - information architecture & admonition class?

@Racer159
Copy link
Contributor Author

Sure! Just let me know when you are available.

@Madeline-UX
Copy link
Collaborator

Madeline-UX commented Aug 25, 2022

Design Feedback

  • Change Admonation class on index page from info to caution - since this information is important and should not be overlooked.
  • Information architecture for Exaples (including package examples and walkthroughs under the same category)

@Racer159 Racer159 merged commit beaa49e into main Sep 26, 2022
@Racer159 Racer159 deleted the 46-zarf-example-should-be-included-in-this-repo branch September 26, 2022 17:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Contributor Guide
2 participants