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

Rewrite the documentation #8

Draft
wants to merge 12 commits into
base: master
Choose a base branch
from
Draft

Conversation

PadowYT2
Copy link

@PadowYT2 PadowYT2 commented Feb 9, 2025

The title is kinda misleading, but I've done a lot of massive changes to the documentation. At the time of making this, not everything is done. Down below are things which are done/left to do

  • Use Bun instead of NodeJS (and install Biome)
  • Ungroup user guides and development
  • Rephrase the whole documentation
  • Add i18n (closes Site translation #3)

The PR documentation can be viewed at https://pumpkin.padow.ru

${{ runner.os }}-bun-

- name: Setup Bun
uses: oven-sh/setup-bun@v2
Copy link

Choose a reason for hiding this comment

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

@Snowiiii be careful to double chech that stuff changed inside of GitHub workflows isn't malicious 👍

Just feels weird to include in a documentation PR

Copy link
Author

@PadowYT2 PadowYT2 Feb 9, 2025

Choose a reason for hiding this comment

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

be careful to double chech that stuff changed inside of GitHub workflows isn't malicious

oven-sh/setup-bun is made by Bun themselfs

Just feels weird to include in a documentation PR

Not sure how otherwise you would get Bun without installing it

Copy link

Choose a reason for hiding this comment

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

I have no experience with bun, hence why I just wanted to flag Snowii to be a bit careful, since small changes like that might get overlooked in a "oh it's only docs changes, let's push immediately"

Tbh, I think moving docs system to bun and adding better documentation should be separate PRs

Copy link
Author

Choose a reason for hiding this comment

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

Tbh, I think moving docs system to bun and adding better documentation should be separate PRs

Lets wait for Snowiiii response

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.

Site translation
2 participants