docs: add more docs #607
Merged
docs: add more docs #607
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
imranbarbhuiya
added
the
hacktoberfest-accepted
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull Request Overview
This PR significantly expands the documentation for the TagScript library by adding comprehensive documentation for new parsers and transformers. The changes focus on providing clear examples, syntax guides, and API references for end users and developers.
Key changes include:
- Added documentation for 7 new parsers (FiftyFifty, Random, Range, Replace, Slice, Stop, and Integer transformer)
- Enhanced existing documentation with better formatting, usage examples, and comprehensive syntax guides
- Updated navigation metadata to include all new parsers and transformers
- Improved the EmbedParser documentation with detailed examples and developer guidance
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| apps/website/content/docs/tagscript/transformers/string.mdx | Enhanced StringTransformer docs with comprehensive examples and syntax |
| apps/website/content/docs/tagscript/transformers/meta.json | Added IntegerTransformer to navigation |
| apps/website/content/docs/tagscript/transformers/integer.mdx | New documentation for IntegerTransformer with usage examples |
| apps/website/content/docs/tagscript/transformers/index.mdx | Updated transformer list to include new transformers |
| apps/website/content/docs/tagscript/parsers/stop.mdx | New documentation for StopParser with syntax and examples |
| apps/website/content/docs/tagscript/parsers/slice.mdx | New documentation for SliceParser with comprehensive examples |
| apps/website/content/docs/tagscript/parsers/replace.mdx | New documentation for ReplaceParser with usage patterns |
| apps/website/content/docs/tagscript/parsers/range.mdx | New documentation for RangeParser with number generation examples |
| apps/website/content/docs/tagscript/parsers/random.mdx | New documentation for RandomParser with selection examples |
| apps/website/content/docs/tagscript/parsers/meta.json | Added all new parsers to navigation metadata |
| apps/website/content/docs/tagscript/parsers/index.mdx | Updated parser list with comprehensive index |
| apps/website/content/docs/tagscript/parsers/fifty-fifty.mdx | New documentation for FiftyFiftyParser with probability examples |
| apps/website/content/docs/plugins/plugin-discord/parsers/index.mdx | Fixed link reference to EmbedParser |
| apps/website/content/docs/plugins/plugin-discord/parsers/embed.mdx | Comprehensive enhancement of EmbedParser documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| If no parameters are given, the string will be returned as is. | ||
| If an integer parameter is given, the string will be splitted into an array of strings using payload or space as a separator. | ||
| And will return the element at the given index (integer parameter). | ||
| If an integer parameter is given, the string will be split into an array of strings using payload or space as a separator, |
There was a problem hiding this comment.
Corrected spelling of 'splitted' to 'split'.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please describe the changes this PR makes and why it should be merged:
Status and versioning classification: