search

zshall / program-guide

Television Simulator '99
MIT License
21 stars 19 forks source link

Create documentation site #42

Closed zshall closed 3 months ago

zshall commented 6 months ago

Create a documentation site for Television Simulator v2 so that when the alpha is published there will be articles available about every content engine and configuration option. This should be publicly accessible and easy to navigate on all platforms.

Right now I'm planning on using Notion to host the site since it allows you to embed linked databases and provides templates for adding new content quickly. Changes are automatically updated on the web too. Drawbacks of Notion are that I can't invite just anyone to collaborate since you need to pay per user per month. When the first stable version comes out we could move over to GitHub's wiki or a doc site generator like Docusaurus. (There exist tools that can move Notion to other sites from Markdown export)

This work item is about adding full examples for all implemented content engines plus descriptions and screenshots.

zshall commented 6 months ago

We've started work on v2's documentation. It will live here on Notion for the time being.

zshall commented 6 months ago

v2's issue tracker is now live on Notion. Until the prerelease is published this will act as the issue tracker for internal development tasks.

zshall commented 3 months ago

Going to stick with Notion for documentation unless something changes so this issue can be closed.