Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create user centered documentation website #51

Open
levibostian opened this issue Dec 8, 2018 · 1 comment
Open

Create user centered documentation website #51

levibostian opened this issue Dec 8, 2018 · 1 comment
Labels
docs Documentation update Needs more discussion Needs more thought before acting on it. Low priority.

Comments

@levibostian
Copy link
Owner

levibostian commented Dec 8, 2018

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)
@levibostian
Copy link
Owner Author

At this time, I am thinking about using VuePress as the project to generate the docs.

Pros:

  • It's open source so it can be extended and will stick around for a long time.
  • Great community around it.
  • Customization via theme and plugin system.
  • Markdown based.
  • Runs locally, generates static files.

Cons:

  • Under heavy active development which means that it's one more thing to keep dependencies updated for.

@levibostian levibostian added Needs more discussion Needs more thought before acting on it. Low priority. docs Documentation update labels Dec 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation update Needs more discussion Needs more thought before acting on it. Low priority.
Projects
None yet
Development

No branches or pull requests

1 participant