Use wiki for developer "meta" docs

[jcbhmr]

I like to use GitHub Pages for user-facing docs (things like JSDoc sites, an example playground, etc.) and GitHub wikis for developer-facing docs (things like conventions, layout, architecture, project history, etc.)

In order to do this in a way that works well with github/git PRs and stuff, it's nice to have a wiki/ dir (or docs/ or something) mirror to the GitHub wiki itself.

Here's a todo thing:

• [ ] Find a GitHub Action to deploy a folder to the wiki
• [ ] Use it
• [ ] Write some of those wiki pages

Wiki page ideas:

• [ ] How to create a template
• [ ] Styleguide.md (commit conventions, formatters, etc.)

related to #10 #8 #7

[jcbhmr]

I'm generally pretty OK at writing docs, so I can do the grunt work.

[jcbhmr]

Some ideas for GitHub wiki actions are:

• https://github.com/newrelic/wiki-sync-action bidi sync
• https://github.com/Andrew-Chen-Wang/github-wiki-action most popular
• https://github.com/spenserblack/actions-wiki up-and-coming; @jcbhmr is contributor (and is probs biased)

[jcbhmr]

You know, before I actually do this I should get a second opinion! Always get a second opinion 😉 That means you @eitsupi

Thoughts on the wiki dev docs idea as a whole? Good idea, bad idea? Alternative better idea? Hold off? Put it all in a big CONTRIBUTING.md file?

[eitsupi]

Thanks for listening to my input.

Actually, I am not too keen on using the wiki for that use.

• I find it difficult to discuss what to edit because there is no Pull Request and review mechanism.
• Markdown files in the main repository should be sufficient.

Also, since what we are dealing with here is a "Development Container," it is highly likely that the user is a developer, and I don't see much point in making a distinction between the two.

Thoughts on the wiki dev docs idea as a whole? Good idea, bad idea? Alternative better idea? Hold off? Put it all in a big CONTRIBUTING.md file?

We can also have a repository dedicated to documents and aggregate documents there. Since this organization is likely to have multiple repositories with similar structures, it seems more suitable to consolidate documents into a single repository.

---

Deploying files from the main repository to the wiki is easy, and I see little need to use dedicated actions. I set like bellow in the other repo. https://github.com/rocker-org/rocker-versioned2/blob/d9dcc2caee7415b97cc14e39239da451798e25cd/.github/workflows/reports.yml#L102-L107