Skip to content

docs: document fallback pages provided by the service - #17

Open
MikkelHebel wants to merge 3 commits into
ctfpilot:developfrom
Brunnerne:docs/16/document-fallback-pages
Open

docs: document fallback pages provided by the service#17
MikkelHebel wants to merge 3 commits into
ctfpilot:developfrom
Brunnerne:docs/16/document-fallback-pages

Conversation

@MikkelHebel

Copy link
Copy Markdown
Member

Summary

Adds a ## Pages section to the README documenting every page this service can serve, what triggers each one, and what it looks like.

  • Lists all generated pages with their title and intended use
  • Documents the two client-side states behind every page (valid challenge-instance subdomain "loading" state with auto-reload polling; anything else gets a generic "Invalid URL!" message)
  • Adds screenshots for each page/state under docs/images/, captured by running generator.py

This closes #16

@MikkelHebel MikkelHebel self-assigned this Jul 4, 2026
@github-actions

github-actions Bot commented Jul 4, 2026

Copy link
Copy Markdown

All Contributors have signed the CLA. Thank you for your cooperation!
Posted by the CLA Assistant Lite bot.

@MikkelHebel

Copy link
Copy Markdown
Member Author

I have read the CLA Document and I hereby sign the CLA

@MikkelHebel
MikkelHebel changed the base branch from main to develop July 4, 2026 20:03
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Removed mention of screenshots being available in both light and dark mode.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document pages provided by the Fallback

2 participants