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

initial pr for full documentation process overhaul #558

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

judson-at-pieces
Copy link
Contributor

documentation added to the README outlining how to comprehensively clone, install dependencies, write documentation, and push changes

documentation added to the README outlining how to comprehensively clone, install dependencies, write documentation, and push changes
Copy link

vercel bot commented Aug 28, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview Sep 5, 2024 7:47pm

README.md Outdated
```
git clone https://github.com/pieces-app/documentation.git
```
:::info
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this will render in Github Readme, since it doesn't behave like Docusaurus


This allows for a hierarchical structure where clicking a category header will either reveal or hide the sub-items it contains.

![An image of the Pieces OS documentation depicting a sidebar.](https://drive.google.com/file/d/1ctD7iZll9nhVDlIUNPWt1RDgtrpoqSv8)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is broken

adjusted note elements to render properly in github
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