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(configuration): update configuration page #6441

Merged
merged 3 commits into from
Oct 11, 2022

Conversation

chenxsan
Copy link
Member

  1. the js-with-links-details code block is hard to maintain, actually we haven't touched it for a long time now, and some configurations inside are outdated, besides, it looks terrible on mobile. However, I can see the benefit of giving an overview of the whole webpack configuration, we might figure out another way to present it in future.
  2. the init section is outdated as well, so I've updated it with a new one.

@vercel
Copy link

vercel bot commented Oct 10, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
webpack-js-org ✅ Ready (Inspect) Visit Preview Oct 11, 2022 at 10:35AM (UTC)

snitin315
snitin315 previously approved these changes Oct 11, 2022
Co-authored-by: Strek <ssharishkumar@gmail.com>
@arklanq
Copy link

arklanq commented Feb 3, 2023

I don't understand why have you removed documentation regarding an overview of all available options. The only way to do this now is to dig in the commits history in this repo. These options overview is pretty useful though.

@chenxsan
Copy link
Member Author

chenxsan commented Feb 4, 2023

I don't understand why have you removed documentation regarding an overview of all available options. The only way to do this now is to dig in the commits history in this repo. These options overview is pretty useful though.

Hi, the current implementation is hard to maintain or update causing stale content, if you know any better ways to maintain, please share with us so we can add it back.

@arklanq
Copy link

arklanq commented Feb 4, 2023

You are still maintaining typescript types declarations, perhaps you could reuse them to automatically generate an overview of these options based on the Configuration interface?

There are already projects which offer similar functionalities, like TypeDoc or DocDash, I don't know if they would be helpful for you.

At least it is some idea that can be explored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants