Skip to content
This repository was archived by the owner on Jul 13, 2020. It is now read-only.

Updates to readme #396

Merged
merged 1 commit into from
Jun 11, 2015
Merged

Updates to readme #396

merged 1 commit into from
Jun 11, 2015

Conversation

probins
Copy link
Contributor

@probins probins commented Jun 11, 2015

Proposes:

Question: why is https://github.com/systemjs/systemjs/blob/master/docs/es6-modules-overview.md in systemjs? This surely belongs here.

* [Production workflows](docs/production-workflows.md)
* [Circular References & Bindings](docs/circular-references-bindings.md)
* [Extending the loader through loader hooks](docs/loader-extensions.md)
* [Tracing API](docs/tracing-api.md)
Copy link
Member

Choose a reason for hiding this comment

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

These links do need to be at the top. Perhaps make the first one an anchor link within the README if that's what you're after?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

These links just repeat what's in the previous section (in a more concise form), and it seemed to me that people coming to this file would want to read the getting started section first, and only then maybe want to move on to more details. So put the documentation links at the end

Copy link
Member

Choose a reason for hiding this comment

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

The links at the top might be missed, with users wondering where the docs are - nice to make it easy to find on the page.

@guybedford
Copy link
Member

Thanks, note that because this repo provides no production workflow, it is not suitable for end-users and is more appropriate for implementors at this point. So the documentation is moving to reflecting that as well somewhat, hence why the basic ES6 module info was removed.

@probins
Copy link
Contributor Author

probins commented Jun 11, 2015

if you're moving general usage docs to systemjs, it might be better to have the note on Promise.all in there (somewhere)

guybedford added a commit that referenced this pull request Jun 11, 2015
@guybedford guybedford merged commit ea56363 into ModuleLoader:master Jun 11, 2015
@guybedford
Copy link
Member

In general, it is advisable to have a single main entry point over multiple import promises, so it's not something I'd want to encourage too heavily.

@guybedford
Copy link
Member

Thanks again for the suggestions - it's great to have this documentation feedback.

@probins
Copy link
Contributor Author

probins commented Jun 11, 2015

I'm using it for optional loads: parse querystring into an array and load the requested components with Promise.all. I don't think it makes sense in a static situation.

@probins probins deleted the patch-1 branch June 11, 2015 13:14
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants