Uploaded image for project: 'PHP ORMs'
  1. PHP ORMs
  2. PHPORM-31

Split documentation into multiple files

    • Type: Icon: New Feature New Feature
    • Resolution: Done
    • Priority: Icon: Unknown Unknown
    • laravel-4.0.0
    • Affects Version/s: None
    • Component/s: Laravel
    • Labels:
      None

      The library documentation is currently entirely contained in the readme file. This makes it difficult to read and comprehend. The documentation should be split into several sections (files), with each section linked from the main readme file. Documentation will be kept in the GitHub repository for the time being; a move to the MongoDB docs infrastructure will be part of a separate project.

      • First Steps
        • Document prerequisites, installing the library, establishing a connection
      • Creating models
        • Document how to store data in MongoDB using the Model class
        • Document relationships (embedded documents, references)
      • Query syntax
        • Show usage known from Laravel
        • Document MongoDB specific query operators (e.g. exists, geoNear)
        • Document how to run aggregation pipelines or other queries not supported by Eloquent
      • Transactions
      • Schema support
      • Cookbook
        • Cross-Database Relationships
        • Authenticatable users
        • Soft Deletes (consider removing)

      In addition to the user documentation, the contributing.md file should be expanded to include instructions for testing changes locally.

            Assignee:
            jerome.tamarelle@mongodb.com Jérôme Tamarelle
            Reporter:
            andreas.braun@mongodb.com Andreas Braun
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: