Update README

[lucperkins]

• Update README and remove flake
• Remove flake checker check

Summary by CodeRabbit

• Documentation
  • Reworked issue-reporting section with clearer headings and bullet points.
  • Expanded project list with direct issue links for easier navigation.
• Chores
  • Simplified CI link checking by switching to a nix-based invocation and removing a third-party action.
  • Introduced a configurable environment variable for pinned Nix packages in CI.
  • Removed Nix flake/dev shell configuration to streamline repository tooling.

[coderabbitai]

Walkthrough

Workflow now sets NIXPKGS, removes flake-checker-action, and runs lychee via nix run from the pinned flake. README reorganizes issue-reporting guidance with bullets and expanded project links. The flake.nix file is removed, eliminating previous devShells and outputs configuration.

Changes

Cohort / File(s)	Summary
CI workflow update .github/workflows/check.yml	Adds NIXPKGS env, removes flake-checker-action, replaces previous lychee invocation with nix run using the pinned flake, preserving token and README args.
Documentation rework README.md	Renames issue section, restructures guidance into bullets, and expands project/issues list with specific entries and links.
Nix flake removal flake.nix	Deletes entire flake configuration, removing inputs.nixpkgs, outputs, and devShells definitions.

Sequence Diagram(s)

sequenceDiagram
    actor GH as GitHub Actions
    participant WF as Workflow Runner
    participant Nix as nix (pinned via NIXPKGS)
    participant LYC as lychee
    participant GHAPI as GitHub API
    participant FS as README.md

    GH->>WF: Trigger check workflow
    WF->>WF: Set env NIXPKGS
    WF->>Nix: nix run ${NIXPKGS}#lychee -- -a $TOKEN README.md
    Nix->>LYC: Execute lychee
    LYC->>FS: Scan links
    LYC->>GHAPI: Use token for rate-limited checks
    LYC-->>WF: Report results

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A bunny taps the CI keys—hop, hop!
Flakes are gone; we nix-run lychee nonstop.
README trails now neatly bloom,
Links get checked, dispelling gloom.
With paws on docs and builds in sight,
We bound ahead—ears up, green light! 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title “Update README” accurately describes one aspect of the pull request but omits other significant changes such as removing the flake configuration and updating the workflow. It therefore only partially reflects the scope of the changes. Because it still relates to a real part of the changeset, it meets the criteria for a passing but incomplete title.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch update-readme

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

.github/workflows/check.yml (2)

30-32: LGTM; consider CI-friendly lychee flags.

The pinned nixpkgs lychee invocation is solid. Consider adding:

• --no-progress (quieter CI logs)
• --max-concurrency 4 (stability)
• Optionally a config file to ignore known false positives.

Example:
nix run "${{ env.NIXPKGS }}#lychee" -- --no-progress --max-concurrency 4 --github-token ${{ env.GITHUB_TOKEN }} README.md

---

20-20: Pin custom actions; verify OIDC permission; add timeout

• .github/workflows/check.yml lines 24 & 26: replace @main with a specific tag or commit SHA for DeterminateSystems/determinate-nix-action and flakehub-cache-action.
• Line 16: confirm whether id-token: write is required; remove or narrow the permission if not.
• No timeout-minutes configured—add (e.g., timeout-minutes: 10) to the job or key steps.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 18e9ae2 and 08ba5c8.

⛔ Files ignored due to path filters (1)

• flake.lock is excluded by !**/*.lock

📒 Files selected for processing (3)

• .github/workflows/check.yml (1 hunks)
• README.md (1 hunks)
• flake.nix (0 hunks)

💤 Files with no reviewable changes (1)

• flake.nix

🔇 Additional comments (1)

README.md (1)

12-20: Clearer issue-filing guidance.

Concise, helpful separation of FlakeHub/docs vs OSS projects. Links resolve via refs; looks good.