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

Module API #1209

Merged
merged 4 commits into from
May 17, 2017
Merged

Module API #1209

merged 4 commits into from
May 17, 2017

Conversation

skipjack
Copy link
Collaborator

@skipjack skipjack commented May 13, 2017

Port module api page from old docs.

Took the content from https://webpack.github.io/docs/api-in-modules.html and
started re-organizing it. This is still a work in progress.

Fixes #1099 and adds a significant bit of missing documentation.

@skipjack skipjack requested review from bebraw and simon04 May 13, 2017 04:21
@skipjack
Copy link
Collaborator Author

skipjack commented May 13, 2017

@simon04 @bebraw this is still a first draft, but I'm interested in your thoughts on the structure which I changed a bit from the original page in the old docs. I think it will read better this way as most things are now grouped by style usage.

Copy link
Contributor

@bebraw bebraw left a comment

Choose a reason for hiding this comment

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

Good start. Not a lot to go till it can be merged.

@skipjack skipjack added the API label May 13, 2017
@skipjack
Copy link
Collaborator Author

@bebraw @simon04 I think this is good to go... can one of you give it another quick skim before I merge? I tried to simplify some of the examples and clean up some of the grammar in the descriptions.




## Webpack
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense to split here and push webpack specifics to another article? It's quite long otherwise.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think maybe it would make more sense to split at the ## Module Variables section? Until we have that a nicer page grouping (#438) maybe something like module-api-methods.md and module-api-variables.md?

Copy link
Collaborator Author

@skipjack skipjack May 16, 2017

Choose a reason for hiding this comment

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

Idk I guess it could work to split out webpack specific functionality sections separate, I just think it may be odd having to jump around the two articles to see all module variables (methods would probably be ok as people would most likely choose one method and stick with it).

Copy link
Contributor

Choose a reason for hiding this comment

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

Variables is a good split, yeah.

@skipjack skipjack merged commit 6b752f7 into master May 17, 2017
@skipjack skipjack deleted the module-api branch May 17, 2017 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants