Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[Bug]: Documentation link in README.md is dead end (HTTP 404)

Open Beginner friendly
  • Is something wrong?
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
85/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
swift
Domain
documentation

Research direction

Inspect the documentation link in README.md and compare it with the package's page on Swift Package Index. Update the dead link so it reaches the package documentation, then verify that the README URL loads successfully instead of returning HTTP 404.

Written by the indexing model from the issue text.

Description

bug
Describe the bug

Clicking on the documentation link in the ReadMe.md returns 404 Not Found on the Swift Package Index site. Searching for "format" on the SPI also doesn't return anything matching the link name ("XcodeProjectFormat"). Perhaps it doesn't exist yet?

Steps to reproduce

Click on the link in the readme (https://swiftpackageindex.com/apple/xcode-project-format/documentation/XcodeProjectFormat).

Expected behavior

Documentation on the package index should load correctly.

Stack trace
Environment

N/A

Additional context

No response

Dominant language
Swift
Stars
384
Forks
12
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apple/xcode-project-format

All issues in apple/xcode-project-format

Similar issues

More Swift issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.