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.

Sign up for GitHub

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

Jump to bottom

Docs: Relative links to SCSS docs don't work when visited from deployed docs #1498

Closed
1 of 2 tasks
benjamincharity opened this issue May 9, 2019 · 0 comments · Fixed by #1560
Closed
1 of 2 tasks

Docs: Relative links to SCSS docs don't work when visited from deployed docs #1498

benjamincharity opened this issue May 9, 2019 · 0 comments · Fixed by #1560
Assignees
@shani-terminus
Labels
Focus: docs Issues concerning the library documentation P3: Important Target: latest Issues related to the latest version of the library (master) Type: bug An implemented item with undesired effects

Comments

@benjamincharity
Copy link
Contributor

benjamincharity commented May 9, 2019 •
edited by shani-terminus
Loading

When we deploy our TypeScript docs the tool consumes our README and places it in a new location which breaks the relative style docs links.

Reproduction

  • Go to https://github.com/GetTerminus/terminus-ui
  • Click on a link under Versioned Documentation and Demos
  • Once at the deployed docs, clicking on the docs link for any style helpers will result in a 404.
  • Change style docs links to absolute URLS
  • Update versioned docs links to be more specific
    • Old: Latest Documentation
    • New: Latest TypeScript Documentation
@benjamincharity benjamincharity added Type: bug An implemented item with undesired effects Focus: docs Issues concerning the library documentation P3: Important Target: latest Issues related to the latest version of the library (master) Needs: planning Items that need discovery/refinement/details/etc labels May 9, 2019
@benjamincharity benjamincharity self-assigned this May 9, 2019
@benjamincharity benjamincharity removed the Needs: planning Items that need discovery/refinement/details/etc label May 16, 2019
@benjamincharity benjamincharity removed their assignment May 16, 2019
@shani-terminus shani-terminus self-assigned this Jun 17, 2019
shani-terminus added a commit that referenced this issue Jun 17, 2019
@shani-terminus
fix(SCSS): docs links to SCSS helpers are working properly
1d52509 
ISSUES CLOSED: #1498
@shani-terminus shani-terminus mentioned this issue Jun 17, 2019
Merged
benjamincharity pushed a commit that referenced this issue Jun 18, 2019
@shani-terminus @benjamincharity
fix(SCSS): docs links to SCSS helpers are working properly
edd3a33 
ISSUES CLOSED: #1498
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shani-terminus shani-terminus

Labels
Focus: docs Issues concerning the library documentation P3: Important Target: latest Issues related to the latest version of the library (master) Type: bug An implemented item with undesired effects
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(SCSS): docs links to SCSS helpers are working properly GetTerminus/terminus-ui
2 participants
@benjamincharity @shani-terminus