Skip to content

docs: document fallback pages provided by the service#7

Open
MikkelHebel wants to merge 1 commit into
ctfpilot:developfrom
Brunnerne:docs/6/document-fallback-pages
Open

docs: document fallback pages provided by the service#7
MikkelHebel wants to merge 1 commit into
ctfpilot:developfrom
Brunnerne:docs/6/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
  • Adds screenshots for each page under docs/images/, captured by running generator.py

This closes #6

@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

@The0mikkel The0mikkel linked an issue Jul 10, 2026 that may be closed by this pull request
2 tasks
Comment thread README.md
Comment on lines +48 to +59
<details>
<summary>Preview of each page</summary>

| | |
| --- | --- |
| **Index** ![Index page](docs/images/index.png) | **401 Unauthorized** ![401 page](docs/images/401.png) |
| **403 Forbidden** ![403 page](docs/images/403.png) | **404 Not found** ![404 page](docs/images/404.png) |
| **405 Method Not Allowed** ![405 page](docs/images/405.png) | **500 Error** ![500 page](docs/images/500.png) |
| **502 Bad gateway** ![502 page](docs/images/502.png) | **503 No service available** ![503 page](docs/images/503.png) |
| **504 Gateway timeout** ![504 page](docs/images/504.png) | |

</details>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good to mention, that the screenshot are from the light mode, and dark mode is active if the system preffers dark.

Comment thread README.md
Comment on lines +38 to +46
| `index.html` | Error | Generic fallback page for errors that don't have a more specific page |
| `401.html` | Unauthorized | Authentication is required to access this resource |
| `403.html` | Forbidden | The request is authenticated but the caller doesn't have permission |
| `404.html` | Not found | The requested page could not be found |
| `405.html` | Method Not Allowed | The HTTP method used is not supported for the requested resource |
| `500.html` | Error | Same generic message as `index.html`, with an added link back to the home page |
| `502.html` | Bad gateway | The service did not respond correctly |
| `503.html` | No service available | The service is temporarily unavailable, e.g. while restarting or under maintenance |
| `504.html` | Gateway timeout | The service did not respond in time, e.g. while restarting or under maintenance |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: The "Intended use" column's text should have a "." at the end of the sentences.

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