Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

spec diffs can be hard to read #271

Open
joshmoore opened this issue Nov 21, 2024 · 4 comments
Open

spec diffs can be hard to read #271

joshmoore opened this issue Nov 21, 2024 · 4 comments

Comments

@joshmoore
Copy link
Member

In #249 (comment), @d-v-b pointed out that the current strategy can lead to situations where there's no clear diff for a spec change (especially related to dev versions). For 0.5, @normanrz and I are going to proceed with the current 0.5/ directory to reduce churn, but for the release of 0.6 it might make sense to collapse the versions down. A priority will be maintaining the existing URLs, though a redirect would likely be acceptable.

@joshmoore joshmoore changed the title spec diffs become unreadable, not sure if there is a way to avoid that as long as we are doing copy + paste spec diffs can be hard to read Nov 21, 2024
@joshmoore
Copy link
Member Author

Depending on the solution, also:

  • evaluate dropping latest
  • or symlinking (might require a more substantial web server)
  • dropping bikeshed

@normanrz
Copy link
Contributor

I just want to add that both the docs and the specs should have a favicon. Right now they have the default RTD and W3C icons.

@normanrz
Copy link
Contributor

I think the best way of organizing versions would be through git branches/tags. That adds a bit more complexity to the rendering. I don't know what to do about bikeshed.

@joshmoore
Copy link
Member Author

A fairly easy mechanism would be to retroactively attach them as builds which get downloaded from GitHub for rendering.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants