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 Wiki #72

Open
pacollins opened this issue Oct 25, 2017 · 6 comments
Open

Create Wiki #72

pacollins opened this issue Oct 25, 2017 · 6 comments

Comments

@pacollins
Copy link
Collaborator

pacollins commented Oct 25, 2017

Need some opinions on this. Should we keep the README.md clean and more descriptive and move things like explaining shortcodes/features to the Wiki, OR just make the README.md cleaner, OR just make a post within the example site showcasing them all?

@BernCarney
Copy link
Contributor

I think cleaning up the README.md and moving shortcodes/features to the wiki is a good idea. Adding a post (similar to the markdown cheat sheet posts on most themes) showing off the shortcodes wouldn't be a bad idea either.

@pacollins
Copy link
Collaborator Author

Thanks for your input. So you think that utilizing the wiki with images would be better/more appropriate than putting it in the demo site that Hugo hosts?

@henningsway
Copy link

I think more examples and detailed information in a Wiki would be helpful. Of course an example site may be even more helpful, but it may be hard to provide "all the examples" in a single page, especially if there would be mutually exclusive design choices.

So probably do both. ;)

(Ps: I personally would be interested atm in multi-language, multi-menu and fancybox examples.)

@pacollins
Copy link
Collaborator Author

pacollins commented Feb 9, 2018

@henningsway - Realizing I am replying ridiculously late. ML is almost done. MM is stale. Fancybox can be seen here.

@johnatasjmo
Copy link

I think the wiki will help for the non-technical users.

@daberg2
Copy link

daberg2 commented Aug 3, 2019

Howdy,

I was actually just thinking about this as I was trying to navigate the README.md. I personally prefer using the README for things like basic installation and maybe contribution guidelines. Everything else would be better-off in the Wiki. This way, the readme is less cluttered and everything else can be organized into a structure that makes sense and is easy to navigate in the Wiki.

Let me know if you would like some help in organizing the content. I would be happy to help!

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

5 participants