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

125: Add the docs site #23

Merged
merged 3 commits into from
Feb 21, 2024
Merged

125: Add the docs site #23

merged 3 commits into from
Feb 21, 2024

Conversation

javisperez
Copy link
Contributor

@javisperez javisperez commented Feb 20, 2024

https://app.shortcut.com/jozu/story/125/product-docs-site

This PR adds the docs folder.

This uses Vitepress which is a static site generator based on markdown files. And these sources files will live in the ./docs folder.

The final built files / folders will live in the ./.vitepress/dist but is ignored by git because we dont wanna track built output.

@javisperez javisperez self-assigned this Feb 20, 2024
@javisperez javisperez changed the title Add the docs site 125: Add the docs site Feb 20, 2024
Copy link
Contributor

@gorkem gorkem left a comment

Choose a reason for hiding this comment

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

Can you also add a README.md file on to docs that explains how to build/run locally and maybe a reference to markdown examples that document authors can use.

@javisperez
Copy link
Contributor Author

@gorkem all done 94fc69f.
Is kind of basic for now but i think its ok.

@javisperez javisperez merged commit cef8a91 into main Feb 21, 2024
1 check passed
@javisperez javisperez deleted the add-docs branch February 21, 2024 14:11
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