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

Improve documentation for getting started with multipage template #632

Closed
mathisonian opened this issue Apr 23, 2020 · 4 comments
Closed

Comments

@mathisonian
Copy link
Member

Is your feature request related to a problem? Please describe.
Currently the multipage template isn't the most user friendly; users have to read the local README file that gets generated in order to figure out how to do things like create new posts. There is no high-level guide that shows you how to get started quickly as was pointed. out in https://gitter.im/idyll-lang/Lobby?at=5ea21041568e5258e47dc274.

Describe the solution you'd like
The documentation should be improved with a "quick start" section in the README and online.

@nuclearGoblin
Copy link

I am planning to work on this documentation this week.

@mathisonian
Copy link
Member Author

Thanks @gerudo7! That would be greatly appreciated - feel free to post here if you run into any issues or have questions.

@nuclearGoblin
Copy link

Where is the best place for the online entry? Of the existing categories in the online documentation, it seems to fit best in "Overview", but I'm not sure if it's too specific to fall there.

@mathisonian
Copy link
Member Author

Maybe the best place to add it would be a new subsection under the Overview, something like "Multipage template" or "Using Idyll for blogging"

Screen Shot 2020-06-22 at 9 29 28 AM

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

No branches or pull requests

2 participants