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

Demo #565

Open
paulrobertlloyd opened this issue Dec 28, 2022 · 3 comments
Open

Demo #565

paulrobertlloyd opened this issue Dec 28, 2022 · 3 comments
Assignees
Labels
documentation Good documentation benefits everyone
Milestone

Comments

@paulrobertlloyd
Copy link
Collaborator

What part of the documentation isn’t clear?

A number of people have requested a means of seeing the admin interface before getting started with the project.

How could the documentation be improved?

A number of options:

  1. Include more screenshots
  2. Record a screencast (😰)
  3. Provide an online demo – would require integration with a content store and periodic resets of the store and the database.
@paulrobertlloyd paulrobertlloyd added the documentation Good documentation benefits everyone label Dec 28, 2022
@paulrobertlloyd paulrobertlloyd self-assigned this Dec 28, 2022
@paulrobertlloyd paulrobertlloyd added this to the v1.x milestone Jul 5, 2023
@yozlet
Copy link

yozlet commented Aug 6, 2023

I recommend starting with screenshots: they provide most of what people want to know about the experience. You can get super complicated with screenshots (and may need to, eventually) but you can start with a couple of basic grabs in five minutes and that's already an improvement.

Bear in mind that there's a big difference between using screenshots just to show what the UI looks like, versus using them as part of the documentation (e.g. when illustrating how to do a common task). The latter use requires more careful and consistent setup, along with updates when the UI changes.

Try starting with a page called "Screenshots" or "User interface". Bring the browser window size down to 800px wide or less, otherwise the text may be too small and there'll be big expanses of empty space. (I'm sure you get all this already, but hey, maybe you won't be the only one reading this advice.)

@yozlet
Copy link

yozlet commented Aug 6, 2023

And if you want help with a screencast, yell! I've done a few more of them since the Ning days. 😄

@paulrobertlloyd
Copy link
Collaborator Author

@yozlet! Great to hear from you!

I recommend starting with screenshots: they provide most of what people want to know about the experience.

Yeah, I think that would be a really good start. Keep it simple, etc.

And if you want help with a screencast, yell! I've done a few more of them since the Ning days.

I might take you up on that offer; I’d like to have a screencast for the 1.0 release, once I know that things are a bit more settled in the UI.

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

No branches or pull requests

2 participants