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

Fix Readme links in Preferences screen #595

Closed
lidel opened this issue Sep 23, 2018 · 3 comments · Fixed by #871
Closed

Fix Readme links in Preferences screen #595

lidel opened this issue Sep 23, 2018 · 3 comments · Fixed by #871
Labels
effort/hours Estimated to take one or several hours exp/beginner Can be confidently tackled by newcomers good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/enhancement A net-new feature or improvement to an existing feature P2 Medium: Good to have, but can wait until someone steps up status/ready Ready to be worked topic/design-content Content design, writing, information architecture

Comments

@lidel
Copy link
Member

lidel commented Sep 23, 2018

Github UI may be intimidating, we probably could use URLs from github pages to improve UX.

@lidel lidel changed the title Enable DNSLink Fix Readme links in Preferences screen Sep 23, 2018
@lidel lidel added UX status/ready Ready to be worked labels Sep 23, 2018
@jessicaschilling jessicaschilling added topic/design-content Content design, writing, information architecture and removed UX labels Mar 30, 2020
@jessicaschilling jessicaschilling added exp/beginner Can be confidently tackled by newcomers effort/hours Estimated to take one or several hours good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/enhancement A net-new feature or improvement to an existing feature P2 Medium: Good to have, but can wait until someone steps up labels Apr 6, 2020
jessicaschilling added a commit that referenced this issue Apr 22, 2020
Duplicates top-level readme for now -- PoC for GitHub Pages, see #595
@jessicaschilling
Copy link
Contributor

I'm thinking we may actually want to bring these links into IPFS docs themselves:

  • We're pushing to place all explanatory material for our primary projects into one central location
  • We're actually already linking to a bunch of pages in the IPFS docs in the prefs already

@lidel
Copy link
Member Author

lidel commented Apr 23, 2020

For reference, links to docs on Preferences are:

$ rg docs add-on/src/options

add-on/src/options/forms/file-import-form.js
22:                <p><a href="https://docs.ipfs.io/guides/concepts/mfs/" target="_blank">

add-on/src/options/forms/experiments-form.js
72:                <p><a href="https://github.com/ipfs-shipyard/ipfs-companion/blob/master/docs/x-ipfs-path-header.md#x-ipfs-path-header-support-in-ipfs-companion" target="_blank">
94:                <p><a href="https://github.com/ipfs-shipyard/ipfs-companion/blob/master/docs/window.ipfs.md#%EF%B8%8F-windowipfs-is-disabled-for-now" target="_blank">

add-on/src/options/forms/dnslink-form.js
28:                <p><a href="https://github.com/ipfs-shipyard/ipfs-companion/blob/master/docs/dnslink.md#dnslink-support-in-ipfs-companion" target="_blank">

add-on/src/options/forms/gateways-form.js
62:                  <p><a href="https://docs.ipfs.io/guides/guides/addressing/#subdomain-gateway" target="_blank">
121:                    <p><a href="https://docs.ipfs.io/guides/guides/addressing/#subdomain-gateway" target="_blank">

add-on/src/options/forms/ipfs-node-form.js
23:                <p><a href="https://github.com/ipfs-shipyard/ipfs-companion/blob/master/docs/node-types.md#node-types-in-ipfs-companion" target="_blank">

Some are bit long (eg. window.ipfs one), not sure if it all first on a single page, may have "Companion browser extension" category or something.

@jessicaschilling
Copy link
Contributor

First part of this effort (getting the docs onto docs-beta.ipfs.io) is here: ipfs/ipfs-docs#182

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/hours Estimated to take one or several hours exp/beginner Can be confidently tackled by newcomers good first issue Good issue for new contributors help wanted Seeking public contribution on this issue kind/enhancement A net-new feature or improvement to an existing feature P2 Medium: Good to have, but can wait until someone steps up status/ready Ready to be worked topic/design-content Content design, writing, information architecture
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants