Update Docs on Website

[mishavetl]

Hello,

Documentation on the website is really outdated and not full. I can try to update it

Thanks!

[slogsdon]

Hi @mishavetl, and thanks for the feedback! Could you specify what is out of date? We had recently went through our documentation to update recently changed parts, so we're hoping there wasn't anything we missed.

Anyways, we'd gladly accept any PR's if you want to help out, and if you have any questions along the way, just let us know!

[mishavetl]

There is no docs on args in routes

[slogsdon]

Ah, gotcha. I'm not sure how that got missed. Maybe because of Sugar using the same underlying routing as Plug.Router. Essentially, you have two options for arguments in routes:

• simple parameter: prefixed with : and will capture a single segment. Example - /message/:username:
  • doesn't match /message
  • matches /message/jim_bob
  • doesn't match /message/jim_bob/from
• glob: prefixed with * and will capture any remaining segments. Example - /message/*args:
  • doesn't match /message
  • matches /message/jim_bob
  • matches /message/to/jim_bob
  • matches /message/to/jim_bob/from/mary_jane

For both simple parameters and globs, the capture is named with whatever comes after the prefix character, and whatever is acceptable for Elixir identifiers can be used for the name of the capture.

[ghost]

@mishavetl May I have your opinion about the current state of the documentation? :)

[mishavetl]

I think it is much better.