Skip to content

Create user centered documentation website #51

@levibostian

Description

@levibostian

At this time, the README for the project does what it needs to do. It covers everything you need to know to install and use Wendy in your own app. However, as Wendy adds more functionality to itself (such as testing utilities), and it becomes more stable and ready for more of the public to use, a dedicated documentation website is a huge step forward for the library.

Documentation beyond a README. A full documentation website including:

  • Getting started
  • Learn in more detail about why Wendy works the way it does
  • Slowly learn how to perform intermediate to advanced functionality of Wendy
  • Learn how to create tests against it
  • Learn how to create custom views to connect to Wendy
  • Learn the best practices of using Wendy
  • Learn how to debug against Wendy during development
  • Learn how to use Wendy to complete all of your various use cases
  • Learn how to go beyond Wendy and build a full offline-first mobile app

Requirements:

  • Static website generated and hosted on GitHub pages
  • All material hosted on GitHub pages as source code files located in this repo (not using a CMS that requires a user login to edit content)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Needs more discussionNeeds more thought before acting on it. Low priority.docsDocumentation update

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions