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

Documentation Issues #209

Open
40 of 45 tasks
indifferentghost opened this issue Oct 10, 2018 · 0 comments
Open
40 of 45 tasks

Documentation Issues #209

indifferentghost opened this issue Oct 10, 2018 · 0 comments
Labels
documentation

Comments

@indifferentghost
Copy link
Contributor

indifferentghost commented Oct 10, 2018 •
edited
Loading

can-route.html

  • misspelling aswell -> as well
  • update examples:
    • imports from can
    • codepen
    • updated data to more closely follow modern routing.
  • remove references of hooking up route.data to HTMLElements.
  • indentation

can-route.start.html

  • codepen
  • add description
  • indentation

discourse:

  • I'm not sure if the Use section example is necessary.

can-route.stop.html

  • codepen
  • add description
  • indentation

can-route.currentRule.html

  • codepen
    • move example from body to signature.
  • indentation

can-route.rule.html

  • find relevant usecase

can-route.deparam.html

  • codepen
  • indentation
  • updated

discourse:

  • Deparaming directly from the location.hash renders an empty #! property. I'm unsure if this is intended. Demo

can-route.isCurrent

  • codepen
  • added @description.
  • indentation
  • spelling agains -> against

can-route.link.html

  • codepen
    • moved example from body to signature
    • moved relevant example from body to props param.
    • updated example comments to include leading ampersand &.
  • indentation
  • deprecate.

can-route.param.html

  • codepen
    • moved example from body to signature
  • indentation

can-route.url.html

  • codepen
  • indentation
  • example to show how to build a full URL. Possible Demo

can-route.data.html

  • deprecate setting to HTMLelement
    • linked to routing guide.
  • Demo is broken
  • removed complete example heading in favor of routing guide.
  • fully relevant/useable codepens
@indifferentghost indifferentghost mentioned this issue Oct 18, 2018
Merged
36 tasks
indifferentghost added a commit that referenced this issue Nov 7, 2018
@indifferentghost
Deprecated route.link
9c8056f 
- There were some issues creating a deprecated group in can-route.md. Added to #209.
indifferentghost added a commit that referenced this issue Nov 8, 2018
@indifferentghost
Fixing documentation issues (#211)
8554cf5 
* Updated examples to use codepen and indentation.

* Moved documentation from inline to seperate files.

This includes the following documentation
- deparam
- isCurrent
- link
- param
- url

All documentation is avaliable in the doc folder.

* removed newline split from start.md

* Updated examples and linked to Codepen.

- currentRule.md
- deparam.md
- isCurrent.md
- link.md
- param.md
- url.md

* updated deparam documentation and example.

* Incremental Changes to Examples and Docs

`doc/currentRule.md` needed major updates to the signature example so it
would work. This includes starting the route and adding Timeouts.

Other changes are minor refactoring to improve over all consistency.

* Updated examples and documentation for can-route and data. Fixed spacing in link and url.

* minor doc and example updates.

This includes removing examples that have been deemed redundant.

* Deprecated route.link

- There were some issues creating a deprecated group in can-route.md. Added to #209.

* Added example to show possible use for using route.stop.

* Minor documentation updates and examples

* added note about how route.rule is used.

* removed incorrect doc from rule.md

* Small documentation updates

* using Safari 11 in SauceLabs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@chasenlehara @indifferentghost