Skip to content

Documentation pages for Setup (Linux, Windows, macOS) are empty on ReadTheDocs #4826

@thunderbird7413

Description

@thunderbird7413

Hi team,
I noticed that several documentation pages in the EvalAI ReadTheDocs site appear to be incomplete or completely empty.

Affected Pages

These pages currently show only a title but no actual content:

  • Docker Setup
  • Linux Setup
  • Windows Setup
  • macOS Setup
  • Possibly other pages under Getting Started → Setup

Issue Summary

The pages are visible in the sidebar, but when opened they appear to contain only:

  • Page title
  • Empty body
  • Navigation buttons ("Previous" / "Next")

This seems like either:

  • The .rst files exist but are empty
  • The content was not added to the Sphinx build
  • The pages are placeholders that were never completed
  • They were mistakenly excluded from the documentation build

Impact

  • New contributors cannot properly set up EvalAI on their systems.
  • The hosts and developers following the docs may face confusion.
  • This reduces usability and onboarding for the project.

Suggestion

  • Verify if the corresponding .rst files exist under docs/source/
  • Add missing content or hide these pages until they are properly documented
  • (If helpful) I’m willing to contribute and help improve the documentation once the expected structure or missing details are clarified.
  • And finally I can solve this issue early.

If you want, I can also help you create a PR after this issue is opened.

Image Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions