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.

Sign up for GitHub

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

Jump to bottom

update docs #521

Merged
merged 16 commits into from
Mar 16, 2021
Merged

update docs #521

merged 16 commits into from
Mar 16, 2021

Conversation

Rich-Harris
Copy link
Member

Bringing the docs up to speed and giving them a bit of an overhaul where necessary. Would like to improve the styles/readability a bit while we're at it

@Rich-Harris
Copy link
Member Author

Rich-Harris commented Mar 14, 2021 •
edited
Loading

Partial TODO (will add to this as I think of stuff):

  • AMP
  • CLI
  • Adapters
  • Configuration
  • Check all the links
  • Fix the styles
  • Service workers
  • Prerendering
  • Migration
  • Form data

@benmccann
Copy link
Member

What's the idea behind renaming some of the docs to xx-? Will they still show up? If so, in what order?

@Rich-Harris
Copy link
Member Author

the xx- docs are things that i want to get rid of, but which contain paragraphs that might be useful. they are excluded from the page

Conduitry
Conduitry reviewed Mar 15, 2021
View reviewed changes
documentation/docs/05-imports.md Outdated Show resolved Hide resolved
documentation/docs/01-routing.md Outdated Show resolved Hide resolved
documentation/docs/01-routing.md Show resolved Hide resolved
documentation/docs/03-loading.md Show resolved Hide resolved
documentation/docs/03-loading.md Show resolved Hide resolved
documentation/docs/06-service-workers.md Outdated Show resolved Hide resolved
documentation/docs/07-a-options.md Show resolved Hide resolved
documentation/docs/08-amp.md Show resolved Hide resolved
documentation/docs/98-configuration.md Outdated Show resolved Hide resolved
documentation/docs/98-configuration.md Outdated Show resolved Hide resolved
Conduitry
Conduitry reviewed Mar 15, 2021
View reviewed changes
documentation/docs/11-cli.md Outdated Show resolved Hide resolved
documentation/docs/11-cli.md Outdated Show resolved Hide resolved
@Rich-Harris Rich-Harris mentioned this pull request Mar 16, 2021
Closed
@Rich-Harris Rich-Harris marked this pull request as ready for review March 16, 2021 02:56
@Rich-Harris Rich-Harris merged commit 7b6d614 into master Mar 16, 2021
@Rich-Harris Rich-Harris deleted the update-docs branch March 16, 2021 02:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Conduitry Conduitry Conduitry left review comments

@pngwn pngwn pngwn left review comments

@benmccann benmccann benmccann left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Rich-Harris @benmccann @pngwn @Conduitry