Skip to content

Conversation

@sedubois
Copy link
Contributor

@sedubois sedubois commented Mar 9, 2017

  • add missing documentation (e.g as is undocumented in declarative )
  • remove documentation redundancies
  • hide away the inline examples in "details" snippet

The improvements are not perfect, but if they are good enough, suggest to merge and refine in later PR.

  • update TOC (how?)

readme.md Outdated
</ul>
</details></p>

Shallow routig allows you to change the URL without running `getInitialProps`. You'll receive the updated `pathname` and the `query` via the `url` prop of the same page that's loaded, without losing state.
Copy link
Contributor

Choose a reason for hiding this comment

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

routig => routing

Copy link
Member

Choose a reason for hiding this comment

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

Someone fixed this in another PR already 😄

@timneutkens
Copy link
Member

On generating the TOC:
https://github.com/zeit/next.js/blame/master/readme.md#L11

It uses doctoc

  1. npm install -g doctoc
  2. doctoc

Maybe we should add doctoc as a devdep.

@timneutkens
Copy link
Member

Lets merge this after #1256

@timneutkens timneutkens added this to the 2.0 milestone Mar 15, 2017
@timneutkens timneutkens closed this Jul 1, 2017
@timneutkens timneutkens removed this from the 2.0 milestone Jul 1, 2017
@lock lock bot locked as resolved and limited conversation to collaborators May 12, 2018
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.

3 participants