Feature Request #4723

Revamp Documentation

Added by Lorenzo Pisani about 1 year ago. Updated 8 months ago.

Status:ClosedStart date:03/23/2013
Priority:NormalDue date:
Assignee:Lorenzo Pisani% Done:

100%

Category:Core
Target version:3.3.1
Resolution:fixed Points:1

Description

I'm going to restructure our pages and content as well as cleaning up any inaccurate information that's been piling up over time.

  • any page to be deleted or moved should actually exist in 3.3 with a link or explanation as to why it's gone (so we don't break bookmarks)
  • page structure will be simplified so things aren't nested into arbitrary titles
  • the first pages new users visit will have more complete examples, even if it leads to some duplicated content
  • better linking between pages so people aren't browsing blindly

I'll be keeping all this work in feature/docs-revamp until it's ready. Feel free to help out ;)


Related issues

Copied to Kohana v3.x - Feature Request #4801: Revamp Documentation New 03/23/2013

Associated revisions

Revision ab4f1ebf
Added by Lorenzo Pisani about 1 year ago

reword the install.md documentation page (refs #4723 refs #4644)

Revision c4d54fbb
Added by Lorenzo Pisani 11 months ago

Better Cookie::$salt docs (refs #4723 refs #4644)

Revision dc325e45
Added by Lorenzo Pisani 11 months ago

Fix documentation typo for Cookie::$salt docs (refs #4723 refs #4644)

Revision 35638cdd
Added by Daniel Scholtus 9 months ago

refs #4723 - Chopping off bad practice example.

Zeelot: "The recommended way is to just build the full url from a route without recycling the one in Request.
you don't know which route the user got to your page with, trying to recycle parameters from it is asking for trouble"

So, removing the example...

Revision 8b98fb80
Added by Lorenzo Pisani 9 months ago

Merge pull request #372 from maddes/patch-2

refs #4723 - Chopping off bad practice example.

Revision 073b0465
Added by George Fekete 8 months ago

Rearranged sidebar menu (refs #4723)

History

#1 Updated by Lorenzo Pisani 9 months ago

This is the PR being used for the work: https://github.com/kohana/core/tree/feature/docs-revamp

#2 Updated by Lorenzo Pisani 8 months ago

  • Status changed from Assigned to Closed
  • % Done changed from 0 to 100
  • Resolution set to fixed

Merged for now. Will make more specific PRs and tickets for the future changes.

#3 Updated by Lorenzo Pisani 4 months ago

Also available in: Atom PDF