theupdateframework / theupdateframework/theupdateframework.io
Spec page rework suggestions
Open
@chalin is already working on this.
Since Oct 12, 2024.
- Dominant language
- HTML
- Stars
- 25
- Forks
- 46
- PR merge metrics
- No merged PRs in 30d
Description
Originally posted by @jku in https://github.com/theupdateframework/theupdateframework.io/issues/105#issuecomment-2401663449 and https://github.com/theupdateframework/theupdateframework.io/pull/105#issuecomment-2401680928
Looks nice.
On content/en/spec.md:
- is the idea that spec maintainers should update this page too when they make a specification release? This feels like unnecessary process. I would suggest replacing the list with:
- Large button to current TUF specification
- A bit of additional info like: "Specification is maintained at https://github.com/theupdateframework/specification/, full list of releases is available in ..."
- Currently the link for list of releases
/specification/list/is broken: should be/specification/
Also header for the "spec" tab seems wrong -- it's got a large image that looks a bit placeholdery. Or is this intended?
Compare partial screenshot from docs and spec tab: ...
Tasks
- Fix redirect to spec list - #108
- Propose a rework / reorg of the spec page (?)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.