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

[README files] URLs should point to existing GitHub pages #934

Closed
1 of 6 tasks
kaelig opened this issue Jan 25, 2019 · 1 comment
Closed
1 of 6 tasks

[README files] URLs should point to existing GitHub pages #934

kaelig opened this issue Jan 25, 2019 · 1 comment

Comments

@kaelig
Copy link
Contributor

kaelig commented Jan 25, 2019

Issue

Steps to reproduce

  1. go to https://github.com/Shopify/polaris-react/tree/master/src/components/Autocomplete
  2. click "text field component"

Actual

💣 Links to https://github.com/Shopify/polaris-react/blob/master/components/forms/text-field

Expected

✅ Links to https://github.com/Shopify/polaris-react/tree/master/src/components/TextField

Proposal

For these URLs to work when people click on them in GitHub, this means URLs must be transformed in consuming projects: polaris-styleguide, and polaris-react's storybook.

Here's the proposed action plan:

  • [polaris-react] (temporary) point to the styleguide itself, instead of having 404s in component descriptions: domainless styleguide format -> https://-prefixed styleguide format (See [Storybook] Direct example description links to https://polaris.shopify.com #933)
  • [polaris-styleguide] Remove category in URL in styleguide (and install 302 redirects)
  • Custom marked renderers for links:
    • [polaris-styleguide] Link to actual style guide pages
    • [polaris-react] Link to storybook stories
  • [polaris-react] Update links in README files to be in "GitHub format

Once done, links will work on GitHub, polaris.shopify.com, and in Storybook 🎉

@kaelig
Copy link
Contributor Author

kaelig commented Oct 3, 2019

Closing this as developing the tooling required to enforce those rules would take time we don't have right now.

@kaelig kaelig closed this as completed Oct 3, 2019
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

3 participants