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: improve docs syntax #1394

Merged
merged 5 commits into from
Jan 6, 2024
Merged

docs: improve docs syntax #1394

merged 5 commits into from
Jan 6, 2024

Conversation

henryh0x1
Copy link
Contributor

@henryh0x1 henryh0x1 commented Jan 5, 2024 •
edited
Loading

Describe Your Changes

  • Better syntax for json file
  • Added title for each json file
  • Added admonitions style based on docusaurus
  • Configure prism supports json, javascript, jsx
  • Minor fix some words for consistency after proof read

Fixes Issues

Self Checklist

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

@henryh0x1 henryh0x1 requested a review from 0xSage January 5, 2024 16:48
@github-actions github-actions bot added the type: documentation Improvements or additions to documentation label Jan 5, 2024
@henryh0x1 henryh0x1 added the type: chore Maintenance, integration, packaging related label Jan 5, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 5, 2024 •
edited
Loading

Preview URL: https://7ad06300.jan-qn8.pages.dev

@henryh0x1 henryh0x1 changed the title docs: improve syntax docs: improve docs syntax Jan 5, 2024
@henryh0x1 henryh0x1 merged commit 64c9230 into main Jan 6, 2024
1 check passed
@henryh0x1 henryh0x1 deleted the docs/improve-syntax branch January 6, 2024 01:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@0xSage 0xSage 0xSage approved these changes

Assignees

@henryh0x1 henryh0x1

Labels
type: chore Maintenance, integration, packaging related 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
2 participants
@henryh0x1 @0xSage