luminus-framework / luminus-framework/luminus

routing doc - handling file uploads

Open
#258 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
626
Forks
122
PR merge metrics
No merged PRs in 30d

Description

i just wanted to try doing a quick file upload... but found the topic, all in all, somewhat trickier than what i would have hoped it'd be... so.... i guess it would be really great if the doc on this could be a little bit more... well... elaborate....

in any case.... one thing that i found particularly confusing is the following:
```
(fn [{{{:keys [file]} :multipart} :parameters}]
```
i personally find this sort of destructuring-syntax super hard to parse.... also.... in my case the path turned out to be more like :params -> :file rather than :parameters -> :multipart -> :file

also... how does all of this fit in with what it says just a few lines above:

```
Reitit supports three kinds of parameters. These can be route, query, and body parameters.
```

but like i said.... for me as a total file-upload-noob :-).... all of this is still pretty confusing... :-)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the routing documentation section containing the file-upload example and its parameter overview. Clarify the destructuring syntax, explain the expected parameter path for uploads, and show how file uploads relate to route, query, and body parameters; done means a newcomer can follow the example without the reported ambiguity.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.