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

specs.ipfs.tech should link to github sources #399

Closed
lidel opened this issue Apr 17, 2023 · 2 comments · Fixed by #405
Closed

specs.ipfs.tech should link to github sources #399

lidel opened this issue Apr 17, 2023 · 2 comments · Fixed by #405
Assignees

Comments

@lidel
Copy link
Member

lidel commented Apr 17, 2023

It is not clear how one can get to the sources of the websie, how to open a PR to fix a typo or propose clarification / discuss potential IPIP.

Every page should have a link to github source of itself.

Some prior art:

  • W3C links to commit history in the header preamble:

    2023-04-17_11-12

  • Our utility websites have github icon

    2023-04-17_11-10

I think adding entry after editors to the header of each spec with "Git source" and "Commit history" with GH icon which we already use for personal github lrofile links would be good enough.

@darobin @hacdias thoughts?

@lidel lidel added the need/triage Needs initial labeling and prioritization label Apr 17, 2023
@darobin
Copy link
Contributor

darobin commented Apr 17, 2023

Yes, absolutely, we have that filed at ipfs/spec-generator#10.

I also like this, which we have in W3C:
image

@hacdias
Copy link
Member

hacdias commented Apr 17, 2023

I can definitely take that on after IPFS Thing. It should be reasonably easy to add the link.

@hacdias hacdias removed the need/triage Needs initial labeling and prioritization label Apr 24, 2023
@hacdias hacdias moved this to 🔎 In Review in IPFS Shipyard Team Apr 24, 2023
hacdias added a commit that referenced this issue May 5, 2023
@github-project-automation github-project-automation bot moved this from 🔎 In Review to 🎉 Done in IPFS Shipyard Team May 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants