Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
[docs] View the source on Github links not working in AppBar #23406
Comments
|
Thanks for the report. We're currently not using permalinks for GitHub links so these are prone to grow stale on old deployed docs. We should rethink our "link to github" strategy in general. I think in this example we could use actual permalinks via commit SHA. |
This comment was marked as off-topic.
This comment was marked as off-topic.
|
We had a discussion in the past about this problem. It was somewhat made on purpose, but I can't recall the motivation. These links are barely used:
But it's always a move in the right direction. @dmatranga do you want to work on a pull request? :) diff --git a/docs/src/modules/components/MarkdownDocs.js b/docs/src/modules/components/MarkdownDocs.js
index 7b925a63b2..ac24a91037 100644
--- a/docs/src/modules/components/MarkdownDocs.js
+++ b/docs/src/modules/components/MarkdownDocs.js
@@ -8,7 +8,7 @@ import Head from 'docs/src/modules/components/Head';
import AppFrame from 'docs/src/modules/components/AppFrame';
import EditPage from 'docs/src/modules/components/EditPage';
import AppContainer from 'docs/src/modules/components/AppContainer';
-import { SOURCE_CODE_ROOT_URL } from 'docs/src/modules/constants';
+import { SOURCE_CODE_REPO } from 'docs/src/modules/constants';
import Demo from 'docs/src/modules/components/Demo';
import AppTableOfContents from 'docs/src/modules/components/AppTableOfContents';
import MarkdownElement from 'docs/src/modules/components/MarkdownElement';
@@ -134,7 +134,7 @@ function MarkdownDocs(props) {
}}
disableAd={disableAd}
demoOptions={renderedMarkdownOrDemo}
- githubLocation={`${SOURCE_CODE_ROOT_URL}/docs/src/${name}`}
+ githubLocation={`${SOURCE_CODE_REPO}/blob/v${process.env.LIB_VERSION}/docs/src/${name}`}
/>
);
})} |
oliviertassinari
changed the title
|
Do you need assistance with this issue? |
|
Can I take this ? |
|
@nauman99 Are you already working on this? Don't want to duplicate your effort otherwise I'll take it up. |
|
@ZeeshanTamboli I haven't started it yet. You can take it if you want. |
|
@nauman99 Okay. I will be working on it. |
'View the source on Github' links not working in AppBar Documentation
Current Behavior😯
When I click on a link from this page https://v3.material-ui.com/demos/app-bar/, I get a 404 message.
Expected Behavior🤔
I expect to be led to a page where I can view the source for each of the AppBar samples on Github.
Steps to Reproduce🕹
Steps:
Context🔦
Trying to learn how to use React Material UI components to build a web application.
Your Environment🌎