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

docs: add more usage info #401

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add more usage info #401

wants to merge 2 commits into from

Conversation

RSS1102
Copy link
Contributor

@RSS1102 RSS1102 commented Jun 6, 2024

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

attempting for #398

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@RSS1102
Copy link
Contributor Author

RSS1102 commented Jun 6, 2024

  • stub : For stub, I attempted to add an explanation reference for antfu in README.md.(Perhaps a more detailed explanation of Watcher/JIT should be provided in the jiti repo) I raised a PR to Jiti docs: add detailed explanation of the functionΒ jiti#250.
    I see plans to support -- watch, should we explain the difference between these two in the documentation?

  • inlineDependencies : Is it necessary to further elaborate on the usage instructions that have already been explained in it?(
    But he is indeed not in the rollup option).

    inlineDependencies?: boolean;

  • Mkdist dual format: should mkdist be changed to support this feature.Add a configuration, get:

-esm
   /index.mjs
-cjs
  /index.cjs
  • Decorators
  • Source map usage

@pi0 pi0 changed the title WIP docs: add more detailed explanation for `--stub' docs: add more usage info Jun 13, 2024
@pi0 pi0 marked this pull request as draft June 13, 2024 09:49
@RSS1102
Copy link
Contributor Author

RSS1102 commented Jun 13, 2024

@pi0
πŸ˜€πŸ˜€This is my current progress, I have a few doubts. Do you have any opinions on this? How should I proceed with this PR next?

@pi0
Copy link
Member

pi0 commented Jun 13, 2024

Nice progress. I was not sure when your work would be ready to review if it is i can happily update to merge and iterate.

@RSS1102 RSS1102 marked this pull request as ready for review June 13, 2024 13:08
@RSS1102
Copy link
Contributor Author

RSS1102 commented Jun 13, 2024

Nice progress. I was not sure when your work would be ready to review if it is i can happily update to merge and iterate.

ok,This is what I can currently determine to be the right thing to do, and I believe you can review and determine what the next steps should be.(All the progress and questions are on the list above.οΌ‰

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.

2 participants