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

Code examples in docs link to master regardless of doc version #19099

Closed
2 tasks done
thisismydesign opened this issue Jan 5, 2020 · 2 comments
Closed
2 tasks done

Code examples in docs link to master regardless of doc version #19099

thisismydesign opened this issue Jan 5, 2020 · 2 comments
Labels
docs Improvements or additions to the documentation out of scope The problem looks valid but we won't fix it (maybe we will revisit it in the future)

Comments

@thisismydesign
Copy link

thisismydesign commented Jan 5, 2020 •
edited
Loading

  • The issue is present in the latest release.
  • I have searched the issues of this repository and believe that this is not a duplicate.

Current Behavior 😯

Browsing v4-7-2. docs, the code example points to master: https://v4-7-2.material-ui.com/components/snackbars/#customized-snackbars

Browsing the latest version of docs, the code examples point to master and not to the latest released version: https://material-ui.com/components/snackbars/#customized-snackbars

In this particular case, the code example is not usable as the Alert component hasn't been released yet.

Expected Behavior 🤔

A specific version of the doc should reference the same specific version of the code. The current version should reference the latest release.
@thisismydesign thisismydesign mentioned this issue Jan 5, 2020
Closed
@oliviertassinari
Copy link
Member

This sounds relatively simple to fix. Thanks for raising.

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Jan 11, 2020
@oliviertassinari
Copy link
Member

oliviertassinari commented Jan 11, 2020 •
edited
Loading

Based on #19112, we are going with a different plan of action:

  • We will keep the GitHub link to master, to help contributors.
  • We will move the GitHub link away from the toolbar, hiding it in the menu, as it should rarely be used.
  • We will move the copy link from the menu to the toolbar.

@oliviertassinari oliviertassinari added the out of scope The problem looks valid but we won't fix it (maybe we will revisit it in the future) label Jan 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Improvements or additions to the documentation out of scope The problem looks valid but we won't fix it (maybe we will revisit it in the future)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@oliviertassinari @thisismydesign