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

feat: rework documentation for vitepress #15

Merged
merged 3 commits into from
Jan 15, 2024
Merged

feat: rework documentation for vitepress #15

merged 3 commits into from
Jan 15, 2024

Conversation

aldy505
Copy link
Member

@aldy505 aldy505 commented Jan 13, 2024

We want to streamline the documentation to be better for everyone, since we are missing too much documentation on how to do things correctly, and most of contributors don't work the same way.

This PR lays the groundwork for the documentation site. I use vitepress after considering a few other alternaitves:

  • Vitepress
  • Rspress (requires Rust, not everyone is okay with the bulkyness of it)
  • Docusaurus (is not as lightweight as Vitepress)
  • https://docs.page/

My own consideration includes:

  • It's easy to deploy on GitHub Pages, or at least there are some written documentation for it
  • As minimum configuration as possible, so people would be focus and spend their time more on writing markdown documentation

@aldy505 aldy505 requested review from a team, elianiva and ronnygunawan as code owners January 13, 2024 15:09
Copy link
Member

@elianiva elianiva left a comment

Choose a reason for hiding this comment

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

LGTM, cuma beberapa comment

Comment on lines +17 to +18
- Image proxy service (optional) —> Convert image from blob storage to some relevant versions (black and white for sold
out, etc.)
Copy link
Member

Choose a reason for hiding this comment

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

ini jadi newline?

Copy link
Member Author

Choose a reason for hiding this comment

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

Dari formatternya Jetbrains

docs/application/new-backend-service.md Outdated Show resolved Hide resolved
Co-authored-by: Dicha Zelianivan Arkana <[email protected]>
@aldy505 aldy505 merged commit 0277465 into master Jan 15, 2024
1 check passed
@aldy505 aldy505 deleted the feat/vitepress branch January 15, 2024 00:09
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.

4 participants