work on the wiki

[ff6347]

No description provided.

[dominikwilkowski]

Wanted to ask: I think there is a case to be made for the Wiki to be hosted in a gh-pages branch to give us more design freedom for the wiki and make it searchable. I personally would love to have good docs handy when developing with this API.

A reference sheet that interlinks with examples that are already in the wiki would add a lot of value then too. What do y'all think about that?

Edit: https://github.com/ExtendScript/extendscript.github.io could be used for that too and it makes it easier to submit PR to the wiki. (Wikis are repos and you can make PRs to them directly but not everyone knows that)

[ff6347]

Wanted to ask: I think there is a case to be made for the Wiki to be hosted in a gh-pages branch to give us more design freedom for the wiki and make it searchable. I personally would love to have good docs handy when developing with this API.

Hosting the wiki in its own pages or as part of the orgs .io site would be great. I worked with mkdocs lately. Maybe it is a candidate to bring the wiki to the next level. Some things to keep in consideration. Until now I worked on the wiki like this.

• I have the wiki repo somewhere on my computer

When somebody asks a question on stackoverflow or somewhere else or my students had a problem with scripting I:

• write/test the code
• create a new file in the wiki repo for it
• commit, push, done

It should stay as simple as that. That's why I never moved to a Jekyll gh page.

What about discoverability through search engines? It feels like the wiki gets indexed better then a .io site. There is this article about seo for pages. Maybe it already solves this.

Another thing is that the wiki is editable by everyone in the web interface. Some people contributed like this already. Having it as a !mgh-pages branch would not allow edits that easy.

Still. I love the idea of making it searchable. Maybe this is a trade for some convenience.

A reference sheet that interlinks with examples that are already in the wiki would add a lot of value then too. What do y'all think about that?

I think it's great. 👍🏽