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

Inline docs #2602

Merged
merged 4 commits into from Dec 20, 2018
Merged

Inline docs #2602

merged 4 commits into from Dec 20, 2018

Conversation

lukastaegert
Copy link
Member

This PR contains:

  • bugfix
  • feature
  • refactor
  • documentation
  • other

Are tests included?

  • yes (bugfixes and features will not be merged without tests)
  • no

Breaking Changes?

  • yes (breaking changes will not be merged unless absolutely necessary)
  • no

List any relevant issue numbers:
Resolves #2270.

Description

This will inline the documentation into rollup. This is the minimal version for now: Just the documentation, no website. The corresponding website PR is rollup/rollupjs.org#172

@@ -8,6 +8,7 @@
Pull Request Requirements:
* Please include tests to illustrate the problem this PR resolves.
* Please lint your changes by running `npm run lint` before creating a PR.
* Please update the documentation in `/guide` where necessary
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: could we call it docs over guide?

@lukastaegert lukastaegert merged commit 325d65f into master Dec 20, 2018
@lukastaegert lukastaegert deleted the inline-docs branch December 20, 2018 17:02
```javascript
// rollup.config.js
import fetch from 'node-fetch';
export default fetch('/some-remote-service-or-file-which-returns-actual-config');
Copy link

Choose a reason for hiding this comment

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

I think there might be a small mistake with these promise examples using fetch.
fetch() returns a promise that resolves to a Response which represents a status and a set of HTTP headers, etc. It does contain the response body and does not resolve to a plain object. In this example, you probably need to do something like:

export default fetch('/some-remote-service-or-file-which-returns-actual-config').then(response => response.json());

Here is the Reference.

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.

Proposal: Merge website repo into rollup repo
3 participants