Repository navigation
The generated API reference moves to REFERENCE.md - #10
Conversation
One shape across every package in the account: the README keeps the prose and the reference lives beside it, linked absolutely because a package README renders on nuget.org where a relative link resolves nowhere. Generated by RepositoryTemplate/package-readme@v1 on the Windows runner, which is the only place this repo's -windows target frameworks resolve.
…ository GifFileFormat.csproj declares RepositoryUrl as .../AnythingToGif/tree/master/GifFileFormat, so the generated link came out as .../tree/master/GifFileFormat/blob/main/GifFileFormat/REFERENCE.md and resolved nowhere. package-readme@v1 strips a /tree/ or /blob/ view suffix now; this is what it generates.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5631e40a69
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| | Member | Signature | Summary | | ||
| | --- | --- | --- | | ||
| | `ToFile` | `static void ToFile(FileInfo outputFile, Dimensions dimensions, IEnumerable<Frame> frames, LoopCount loopCount, byte backgroundColorIndex = 0, ColorResolution colorResolution = 7, IReadOnlyList<Color> globalColorTable = null, bool allowCompression = false)` | | | ||
| Every public and protected member of all 9 types, generated from the built assembly and its XML documentation, is in [REFERENCE.md](https://github.com/Hawkynt/AnythingToGif/tree/master/GifFileFormat/blob/main/GifFileFormat/REFERENCE.md). |
There was a problem hiding this comment.
When this README is rendered on NuGet or GitHub, the link cannot reach the new reference because it combines the subdirectory URL /tree/master/GifFileFormat with another /blob/main/GifFileFormat/REFERENCE.md path. The backlink in REFERENCE.md line 3 is constructed the same way, so navigation is broken in both directions; generate both URLs from the repository root and use a single branch/path component.
Useful? React with 👍 / 👎.
1 participant
Part of moving every package in the account to one shape: the README keeps the prose, and the generated reference lives beside it in
REFERENCE.md, linked absolutely because a package README renders on nuget.org where a relative link resolves nowhere.Generated by
RepositoryTemplate/package-readme@v1on the Windows runner — the only place this repo's-windowstarget frameworks resolve. No hand-written prose changed.