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

Consider creating a mini documentation site #45

Open
mendhak opened this issue Nov 30, 2022 · 1 comment
Open

Consider creating a mini documentation site #45

mendhak opened this issue Nov 30, 2022 · 1 comment

Comments

@mendhak
Copy link
Owner

mendhak commented Nov 30, 2022

Something to think over. The README.md is growing very large.

Would it be easier for users if the instructions were in a simple documentation site, with each step in its own section and each calendar/weather provider gets its own page, so users can jump between them easily.

I am thinking of using an Eleventy theme called Spacebook. Eleventy is convenient because the content is in Markdown and any customizations are in Javascript and Eleventy just builds the site.

The menu on the left becomes the links to jump between pages. It would require splitting up the README.md's sections. I could link the README.md to the documentation site.

I could also just redirect the blog post... and include its pieces in the documentation site as well. Maybe.

@mendhak
Copy link
Owner Author

mendhak commented Feb 13, 2023

Dear future me. I think get on that documentation site soon. The README is getting massive, and people will miss steps with so much scrolling.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant