Better website and documentation

[Olical]

The current website (https://conjure.fun) is awful, it's just a bundle of links to other places really, it needs a nice design and set of text to sell and describe the idea as well as route people through to language specific help text.

[kkharji]

Okay, this is something I'd like to invest my time in the upcoming weeks.

Thoughts on steps to take:

• Decide on what pages to have.
  • Here's a list of page to start with and their sections:
    • Home Page:
      • logo and slogan,
      • Demo Video
      • Getting started (code snippets)
      • features in form of slides/walkthrough and not list,
      • roadmap (Empeded Trello?),
      • sub-pages and their description (sub-pages should be in nav bar?)
    • Doc Page (generated from doc/conjure.txt + sections based on client).
• Decide on what tool set to use.
  • Clojurescript + reagent?
• Write the content
• Create design wireframe for the Home Page
• Find a way to auto generate/parse docs into markdown.

[Olical]

So I was initially thinking a single page that acted as a hub to take you to everything Conjure related. Having it walk you through from pitching the idea to installation to documentation and joining the Discord would be a great journey I think.

I'd like to see a linear and engaging layout with a good mix of text and animated examples with highlights about the different supported languages.

Rendering the help as HTML that can get indexed by google etc would be fantastic too, I think the author of vim-iced actually wrote a thing to do just that which is so cool.

I basically want the elevator pitch and selling of the idea + UX to exist at conjure.fun, the repo and wiki would then be about more technical and development / help aspects. conjure.fun should be a root you go to when you want to start using Conjure or need some help with something, right now that place is the wiki.

I think CLJS + Reagent is okay but if it were me I would just do HTML and CSS, I don't like involving JS unless I absolutely need it (I shy away from SPAs, I think they're unnecessary for 95% of use cases from ~8 years of full stack dev). So if you did want to tackle this at some point, it's entirely up to you, but I think HTML and CSS rendered statically with a script is more than good enough.

I already have github pages in the docs directory too by the way. That's where the current site is stored and developed.

Oops, I just kept writing :sweat_smile: I hope that gives you a good idea of what i was thinking at least? I think you're on the right track, I feel like a single page with no JS would be fine, but honestly if you have some good ideas in your head I'm all for it. Whatever you think will get the information across in a good way.

[stelcodes]

I randomly came across this issue and it got my gears turning. I'm very interested in helping make this happen.

I'm writing a Clojure static site generator right now (https://github.com/stelcodes/nuzzle) and I thought "Wow it would be so cool to provide a plugin to render vim help files". So I looked into the vim help tool that @Olical mentioned (https://github.com/liquidz/clj-vimhelp). The parser is fantastic but the hiccup generation is hard to reuse because it uses Hiccup 1.0 which handles escaping poorly. Nuzzle uses Hiccup 2.0 which makes escaping much simpler.

I forked the repo and made the necessary changes and now it works with Nuzzle. Soon you'll be able to write <vimhelp src="doc/conjure.txt"> in a markdown file and the help will get rendered as html, surrounded by the other markdown elements.

Upstream PR: https://github.com/liquidz/clj-vimhelp/issues/5

Thanks for the inspiration!