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.

Sign up for GitHub

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

Jump to bottom

docs: revamp entire Jan guides #2139

Merged
merged 66 commits into from
Mar 4, 2024
Merged

docs: revamp entire Jan guides #2139

merged 66 commits into from
Mar 4, 2024

Conversation

henryh0x1
Copy link
Collaborator

@henryh0x1 henryh0x1 commented Feb 23, 2024 •
edited
Loading

Re-point Pull Request #2138 by @aindrajaya @cahyosubroto with preview available

Add Quickstart Docs and implement Custom plugin

  • Add the quickstart docs and configure the sidebar and docusaurus.config.js file.
  • Add the Docusaurus custom Plugin to fetch recent data from GitHub Releases page.
  • Add another .env.example file variable that store GitHub access token

Checklist before merging:

  • Resolve the issue of Changelog
  • Re-allocate the image files under the assets folder of each page
  • Resolve current incorrect image source, incorrect redirect, typo in documentation

Fixes Issues

  • Closes #
  • Closes #

Self Checklist

  • Added relevant comments, esp in complex areas
  • Updated docs (for bug fixes / features)
  • Created issues for follow-up changes or refactoring needed

aindrajaya and others added 3 commits February 23, 2024 17:26
@aindrajaya
Update quickstart content
4e89732 
Add quickstart content to the Jan docs and update the Docusaurus config and Sidebars
@aindrajaya
Add plugin to fetch GH releases page recent data
fcb909f
@henryh0x1
Merge pull request #2138 from aindrajaya/docs-pena-team
c4ab52b 
Docs pena team - Add Quickstart Docs
@henryh0x1 henryh0x1 mentioned this pull request Feb 23, 2024
Merged
3 tasks
@henryh0x1 henryh0x1 requested review from 0xSage, dan-jan, aindrajaya and cahyosubroto and removed request for 0xSage February 23, 2024 10:56
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 23, 2024 •
edited
Loading

Preview URL: https://575a6af6.jan-qn8.pages.dev

@0xSage 0xSage changed the title docs pena team - Add Quickstart Docs docs: Add Quickstart Docs Feb 24, 2024
@0xSage
Copy link
Contributor

0xSage commented Feb 24, 2024

Gentle reminder, can we:

  1. ship smaller PRs
  2. use conventional commits: https://www.conventionalcommits.org/en/v1.0.0/#summary
    cc @hieu-jan @aindrajaya @cahyosubroto

@0xSage
Copy link
Contributor

0xSage commented Feb 24, 2024

Can I clarify: what's the difference btw quickstart and user guide?

@aindrajaya aindrajaya closed this Feb 26, 2024
aindrajaya
aindrajaya reviewed Feb 26, 2024
View reviewed changes
Copy link
Contributor

@aindrajaya aindrajaya left a comment

Choose a reason for hiding this comment

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

done, already reviewed. Thanks @hieu-jan

@aindrajaya aindrajaya reopened this Feb 26, 2024
@github-actions github-actions bot added the type: documentation Improvements or additions to documentation label Feb 26, 2024
@henryh0x1
Copy link
Collaborator Author

done, already reviewed. Thanks @hieu-jan

Hi @aindrajaya, seems that you're already added to the member of repo. Could you make the changes based on feedback directly to this branch. Also for the future pull request, could you create a pull request from a branch inside repo to get docs preview, so I won't need to re-create another pull request for pointing to get preview like this one.

@0xSage
Copy link
Contributor

0xSage commented Feb 27, 2024

@hieu-jan to work with pena team and just get this one merged.
Delete & remove a lot of the finicky changes.

@henryh0x1 henryh0x1 changed the title docs: Add Quickstart Docs docs: revamp entire Jan docs Mar 4, 2024
@henryh0x1 henryh0x1 changed the title docs: revamp entire Jan docs docs: revamp entire Jan guides Mar 4, 2024
Van-QA
Van-QA approved these changes Mar 4, 2024
View reviewed changes
Copy link
Contributor

@Van-QA Van-QA left a comment

Choose a reason for hiding this comment

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

LGTM

@henryh0x1 henryh0x1 merged commit af1eb80 into dev Mar 4, 2024
1 check passed
@henryh0x1 henryh0x1 deleted the docs-pena-team branch March 4, 2024 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Van-QA Van-QA Van-QA approved these changes

@dan-jan dan-jan Awaiting requested review from dan-jan

@0xSage 0xSage Awaiting requested review from 0xSage

@cahyosubroto cahyosubroto Awaiting requested review from cahyosubroto

@aindrajaya aindrajaya Awaiting requested review from aindrajaya

Assignees

@henryh0x1 henryh0x1

Labels
type: documentation Improvements or additions to documentation
Projects
Jan Project
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@henryh0x1 @0xSage @aindrajaya @Van-QA