Contributor:notes

SCExAO wiki contributor info

This will be particularly relevant for contributors working offline in their own IDE.

Finding resources

This wiki implementation on github is called "Gollum wiki".

https://github.com/gollum/gollum/wiki

Organization suggestions

Maybe we could try to maintain an organization that sets apart the concise and the extensive. What you're looking for in the middle of night, versus what you'd tell your grad students.

Let me know in the comments, yo.

Following bdawg's excellent idea, consistent emoji use throughout can be very meaningful! We could maintain an index if we have time.

• 🔧: Technical details.
• 😎: Polarimetry
• 📷: Vampires single-camera mode.

Links

Please prefer relative syntax for links. Example taken from Home.md:

* [Settings and common commands](./Settings-and-common-commands)

rather than:

* [Settings and common commands](https://github.com/scexao-org/scexao-wiki/wiki/Settings-and-common-commands)

.md file extension should NOT appear in the links.

Delimiter and file organization

Keep files in the root folder. Name files such that : can be used as a folder-level delimiter. This is useful to generate the _Sidebar.md.

_Sidebar

I used a node package to generate and maintain _Sidebar.md, from my local machine. To install the package:

npm install -g github-wiki-sidebar

And then, within the wiki folder:

github-wiki-sidebar