Skip to content

Update documentation #83

@kd-ods

Description

@kd-ods

The documentation needs to be brought up-to-date to reflect current behaviour in the plugin.

On reflection, I think the documentation will remain pretty concise. We should therefore just stick with a ReadMe for now (rather than, for example, moving to multiple markdown files plus a GitHub Pages or ReadTheDocs build). Or at least, let's proceed with that premise.

TOC is something like:

  • Requirements
  • Overview
  • Installation
  • Usage
    • Create a new OFDS project
    • Create an OFDS project from existing data
    • Edit an existing OFDS JSON dataset
    • Validate your OFDS project
    • Export your project as OFDS JSON
    • Save your project as an OFDS GeoPackage
  • FAQs
  • Development

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions