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: Website migration from docusaurus to vitepress #45

Merged
merged 15 commits into from
Apr 15, 2024
Merged

Conversation

quasystaty1
Copy link
Contributor

Description

This PR fully migrates to vitepress usage for docs website generation

  • moving most files to .md format
  • migration to vitepress
  • reorganize the docs structure
  • implement stylistic design for home page
  • adding astria-go-cli "walk through"
  • using npm instead of yarn

Motivation and Context

The docs design and structure need a new styling and home page, vitepress was chosen considering needs.

Screenshots (if appropriate):

image

Types of changes

  • Edits to existing documentation
  • Changing documentation structure (relocating existing files, ensure redirects exist)
  • Stylistic changes (provide screenshots above)

@jbowen93 jbowen93 self-requested a review April 15, 2024 18:41
## Description
<!-- Describe your changes in detail -->

## Motivation and Context
<!-- Why is this change required? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here. -->

## Screenshots (if appropriate):
<!-- Provide before and after screen shots -->

## Types of changes
<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [ ] Edits to existing documentation
- [ ] Changing documentation structure (relocating existing files,
ensure redirects exist)
- [ ] Stylistic changes (provide screenshots above)
Copy link
Member

@jbowen93 jbowen93 left a comment

Choose a reason for hiding this comment

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

LGTM

@quasystaty1 quasystaty1 merged commit 17a2d7e into main Apr 15, 2024
2 checks passed
@quasystaty1 quasystaty1 deleted the vitepress branch April 15, 2024 18:46
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