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

Improve build option docs #219

Closed
1 task
ederzz opened this issue Feb 17, 2023 · 11 comments · Fixed by #363
Closed
1 task

Improve build option docs #219

ederzz opened this issue Feb 17, 2023 · 11 comments · Fixed by #363
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ederzz
Copy link

ederzz commented Feb 17, 2023

Describe the feature

Could u add some docs has more details with build options?
In readme, I could find options in types, but don't get their meaning.

Additional information

  • Would you be willing to help implement this feature?
@pi0 pi0 changed the title Could u add some docs has more details with build options? Improve build option docs Jul 18, 2023
@pi0
Copy link
Member

pi0 commented Jul 18, 2023

@pi0 pi0 mentioned this issue Jul 18, 2023
1 task
@pi0 pi0 added the documentation Improvements or additions to documentation label Jul 18, 2023
@D4RKAR117
Copy link

Would be very useful also the usage of rollup plugins with in unbuild, It's pretty tricky and hidden if you're new to the package

@Barbapapazes Barbapapazes self-assigned this Nov 5, 2023
@Barbapapazes
Copy link
Member

Describe the feature

Could u add some docs has more details with build options? In readme, I could find options in types, but don't get their meaning.

Additional information

  • Would you be willing to help implement this feature?

Hello, thanks for reporting this! I will work on it!

@Barbapapazes Barbapapazes mentioned this issue Nov 5, 2023
8 tasks
@RSS1102
Copy link
Contributor

RSS1102 commented Jan 21, 2024

May I ask why this document has not been pushed forward? As mentioned above, there are many configurations that cannot understand its meaning. I don't even know what functions he can have. 🤔


I can provide assistance for this, if you are willing.

@Barbapapazes
Copy link
Member

Hey, what do you mean by document?

@RSS1102
Copy link
Contributor

RSS1102 commented Jan 21, 2024

What are the configurations in buildonfig and what is the purpose of each configuration.

As he said:

Could u add some docs has more details with build options?
In readme, I could find options in types, but don't get their meaning.

@RSS1102
Copy link
Contributor

RSS1102 commented Jan 22, 2024

🤔 @Barbapapazes so can I provide a PR to build this document? i want to try it.


Perhaps using vitepress?

@Barbapapazes
Copy link
Member

🤔 @Barbapapazes so can I provide a PR to build this document? i want to try it.

Perhaps using vitepress?

The first thing to do is to add some comments to document there types. Actually, there is no need for a full documentation.

@RSS1102
Copy link
Contributor

RSS1102 commented Jan 22, 2024

ok, i will try it frist.

RSS1102 added a commit to RSS1102/unbuild that referenced this issue Jan 23, 2024
@RSS1102 RSS1102 mentioned this issue Jan 23, 2024
8 tasks
@RSS1102
Copy link
Contributor

RSS1102 commented Jan 23, 2024

🤔 @Barbapapazes so can I provide a PR to build this document? i want to try it.
Perhaps using vitepress?

The first thing to do is to add some comments to document there types. Actually, there is no need for a full documentation.

#363 But it seems a bit messy for the code files.
Perhaps there should be some descriptions of packson or build.config.ts

@Barbapapazes
Copy link
Member

🤔 @Barbapapazes so can I provide a PR to build this document? i want to try it.
Perhaps using vitepress?

The first thing to do is to add some comments to document there types. Actually, there is no need for a full documentation.

#363 But it seems a bit messy for the code files.
Perhaps there should be some descriptions of packson or build.config.ts

Will take a look

@pi0 pi0 closed this as completed in #363 Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants