Arched Door is a POC of how an internal documentation website could be made.

Demo:

• Website: https://arched-door.netlify.app/
• Default password: somepassword

It's not about a specific tech, it's about the process:

• Write in plain markdown (or GitHub Flavored Markdown).

• Generate a static website.

• Add auth.

• mdBook.

  • Why? Simple and works perfectly.
  • Supports plugins (inc. pandoc).

• GitHub Actions

  • Quickstart for GitHub Actions | GitHub Docs
  • GitHub Action: Install Rust Toolchain
  • act https://github.com/nektos/act
    • Running GitHub Actions locally.

• Netlify

  • Why? We're more used to Netlify. It's straightforward to use.
  • Alternatives:
    • Vercel. See their middleware example.

Main theme: Desert. Algerian Desert.

Arched Door is the final choice.

• Arched:

  • Literally an arched door.

  • "Arch" as in _arch_itecture, suggesting it is tech-related.

• Door:

  • Charles Dickens' door quote.

  • Think: Door of knowledge.

Other options:

• Brainiac Hatter (Alice in Wonderland)

• Chickadee (bird, memory, able to remember specific things)

• Secretarybird (bird, secretary)

• Stellar Almanac (astronomy-related)

• Red coral

  • Its color looks cool.
  • Red coral is used in Amazigh jewelry.

• Arched Door

See about-mdbook.md.

The GitHub Action expects the following environment secrets:

• NETLIFY_AUTH_TOKEN
• NETLIFY_SITE_ID

It uses a prebuilt binary (fast) and falls back to building from the source (slow).

WTFPL