GH Wiki Tips

This page describes some tips for maintaining ARK community content on the Github (GH) wiki platform, which is mainly used to host ARKA Working Group (WG) documents.

Like every GH repo(sitory), the repo at github.com/arks-org/arks.github.io gets a free wiki, accessible at the repo's URL after appending "/wiki". That is a public wiki, but it points off to a private wiki (under a private repo) for the NAAN WG documents.

Editing

If you know markdown well enough, you can always imitate markdown that you find on the wiki (seen by opening as if in edit mode). GH wiki editing gives a basic overview.

Unlike general GH markdown, GH wiki markdown is missing some functionality. Workarounds are being worked out and described in this document -- please contribute yours! Most maintenance will be done by hand via the web UI, but it is possible (if rarely necessary) to clone the repo to a laptop, edit locally, and push changes back to the repo.

Access URLs can address parts of the repo file hierarchy, but each "leaf" must be unique wherever it appears in the file hierarchy. So if two files occur in different directories, only one of them is visible to wiki users. When given the opportunity to modify the filename in the UI, do NOT enter hyphens; use spaces instead, which will become hyphens in filenames and access links. (Using hyphens will give you a world of pain and invisible files, the only fix being to clone the repo, and do something like git pull; git mv '2024'$'\342\200\220''08'$'\342\200\220''13-Technical-WG-Agenda-and-Notes.md' 2024-08-13-Technical-WG-Agenda-and-Notes.md. Better just not to do it.)

Markdown plus minor HTML (<br>) can fix many things.

Recording dialog (who said what) with newlines preserved may be done best with bulleted lists.

Most common task: editing meeting agendas and notes

Creating a new meeting agenda.

Meetings are listed most recent first. To create a new meeting agenda for a given date, copy the most recent meeting link, change the date (keeping the date format), and save. Then copy the most recent meeting content to your clipboard, click the link you just created (which should be red to indicate that it doesn't exist yet) to open a new empty document, paste, and make appropriate changes within the general format. Note: do not add hyphens to the github filename. If you do so your page will effectively disappear; in page titles all, hyphens are automatically replaced by spaces, so YYYY-MM-DD becomes YYYY MM DD.