Major Docs Patch #43
Major Docs Patch #43
Conversation
| title: Parameters | ||
| url: binding.html | ||
| title: Request Parameters | ||
| url: paramaters.html |
There was a problem hiding this comment.
typo: change "paramaters" to "parameters"
| - `revel run` - will start `dev` mode as the default | ||
| - `revel run prod` - will start with `prod` mode. | ||
|
|
||
| Revel creates new apps with **dev** and **prod** run modes defined, but the user may |
There was a problem hiding this comment.
Perhaps more specifically "the developer may" instead of "user"?
| request flow. This may take the form of recurring tasks that update cached data | ||
| or one-off tasks for sending emails. | ||
| Revel provides the **jobs** framework for performing work asynchronously, outside of the | ||
| request flow. This may take the form of [recurring tasks](#RecurringJobs) that updates cached data |
There was a problem hiding this comment.
"updates" should be "update"
|
So afaik, bar a few teaks, this is ready to merge... |
|
Are you not going to remove the manual |
|
Re title: Currently its this Whats I really like is: title | section | Revel A web...... eg Also this way we can also version.. eg This will avoid confusion if we have duplicate names, eg controllers in manual + godoc I haven't figured out how to do that et, but need a "template set command" or alike However, the title on the home page needs to be more unique as u suggested, and I haven't figured figured how to do that yet. |
|
re named anchors... I've got mixed feeling about using the id tag, namelly different languages.. This is a problem I had with smarty manual from yonder year.. with having to redeclare the link, as the "title" changed... anyway.. that thought is in the back of my head.. I've left a couple in, such as linking to "appconf.html#jobs", as the title is "Scheduled Jobs", and we might wanna change that maybe...but "jobs" dont work alone (in fact might "Jobs" and "Cron" So some of the anchors I left in, and maybe used, but I will nuke them if I find any that offend... and dont think this is that big a deal, there are very few and kinda intentional atmo.. for now if that ok.. If thats whats stopping a "merge".. .then i need time.. and more focused on creating and testing content, eg debugging than removing anchors that work.. |
Am baby sitting my aunt.. so using time to make revel docs better..
here's first patch, but going thru and tweaking bits and pieces..
I kind want to push to the "upstream" origin and have perms, but am nervous to do so.. (maybe into a new "docs_next" branch)