Skip to content

feat: Add Args documentation #12

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

Merged
merged 3 commits into from
May 9, 2025
Merged

Conversation

MacFJA
Copy link
Contributor

@MacFJA MacFJA commented Apr 20, 2025

TODO

  • Add API reference documentation

Will be done in a later PR

  • Add Best Practices - General Guidelines
  • Add Best Practices - Performance Considerations
  • Add Best Practices - Accessibility
  • Add Examples - Basic Examples
  • Add Examples - Advanced Examples

Copy link
Member

@natemoo-re natemoo-re left a comment

Choose a reason for hiding this comment

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

Looks great, thanks for the PR!

I think we could delete the TBD pages for now to merge the new section in, and then split the new content to separate PRs. Will probably do something similar with Tab as well 🫡

@@ -11,6 +11,7 @@
},
"dependencies": {
"@astrojs/starlight": "^0.32.2",
"@bomb.sh/args": "^0.3.1",
Copy link
Member

Choose a reason for hiding this comment

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

Hmm do we need to install this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have to check, but I'm pretty sure that without it twoslash won't be able to do its magic.

But maybe it can be moved into dev dependencies ? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I confirm, without it twoslash don't work.

But it can be moved to devDependencies

Copy link
Member

Choose a reason for hiding this comment

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

yeah, it is required when working with twoslash.

Comment on lines +94 to +97
label: "Args",
id: "args",
icon: "seti:shell",
link: "/args/getting-started",
Copy link
Member

Choose a reason for hiding this comment

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

🙌

@MacFJA MacFJA marked this pull request as ready for review May 1, 2025 16:02
@MacFJA MacFJA requested a review from natemoo-re May 1, 2025 16:03
@dreyfus92
Copy link
Member

Thank you both 🫡

@dreyfus92 dreyfus92 merged commit c6d60fd into bombshell-dev:main May 9, 2025
@MacFJA MacFJA deleted the feat/args branch May 9, 2025 18:37
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.

3 participants