Skip to content

Commit

Permalink
[docs] Fix GitHub capitalization (#33071)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviertassinari committed Jun 9, 2022
1 parent 2ef30e5 commit 7efc7c5
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Expand Up @@ -2000,7 +2000,7 @@ A big thanks to the 15 contributors who made this release possible. Here are som
- &#8203;<!-- 33 -->[core] Add `experiments` index page (#29582) @siriwatknp
- &#8203;<!-- 32 -->[core] Move s3 bucket ownership to mui-org (#29609) @eps1lon
- &#8203;<!-- 31 -->[core] Improve support request message (#29614) @mnajdova
- &#8203;<!-- 30 -->[core] Use support request Github Action (#29594) @mnajdova
- &#8203;<!-- 30 -->[core] Use support request GitHub Action (#29594) @mnajdova
- &#8203;<!-- 29 -->[core] Remove unused `getJsxPreview` util (#29586) @ZeeshanTamboli
- &#8203;<!-- 28 -->[core] Use GitHub issue forms (#28038) @oliviertassinari
- &#8203;<!-- 26 -->[core] Add playground (#29423) @oliviertassinari
Expand Down Expand Up @@ -6055,7 +6055,7 @@ A big thanks to the 24 contributors who made this release possible. Here are som
- [docs] Fix duplicated styles generated from emotion (#23809) @mnajdova
- [docs] Fix icon alignment in /components/breadcrumbs (#23818) @eps1lon
- [docs] Fix production deploy (#23963) @eps1lon
- [docs] Fix source on Github links (#23821) @praveenkumar-kalidass
- [docs] Fix source on GitHub links (#23821) @praveenkumar-kalidass
- [docs] Fix StickyHeaderTable round borders (#23882) @antoniopacheco
- [docs] Fix typo in date picker dayjs adapter name (#23935) @andresmrm
- [docs] Improve system properties page (#23961) @mnajdova
Expand Down
2 changes: 1 addition & 1 deletion docs/data/joy/customization/approaches/ButtonThemes.js
Expand Up @@ -566,7 +566,7 @@ export default function ButtonThemes() {
onChange={(event) => setDesign(event.target.value)}
sx={{ minWidth: 160 }}
>
<option value="github">Github</option>
<option value="github">GitHub</option>
<option value="fluent">Fluent</option>
<option value="chakra">Chakra</option>
<option value="mantine">Mantine</option>
Expand Down
8 changes: 4 additions & 4 deletions docs/scripts/ApiBuilders/ComponentApiBuilder.ts
Expand Up @@ -276,10 +276,10 @@ function extractClassConditions(descriptions: any) {

/**
* @param filepath - absolute path
* @example toGithubPath('/home/user/material-ui/packages/Accordion') === '/packages/Accordion'
* @example toGithubPath('C:\\Development\material-ui\packages\Accordion') === '/packages/Accordion'
* @example toGitHubPath('/home/user/material-ui/packages/Accordion') === '/packages/Accordion'
* @example toGitHubPath('C:\\Development\material-ui\packages\Accordion') === '/packages/Accordion'
*/
function toGithubPath(filepath: string): string {
function toGitHubPath(filepath: string): string {
return `/${path.relative(process.cwd(), filepath).replace(/\\/g, '/')}`;
}

Expand Down Expand Up @@ -348,7 +348,7 @@ const generateApiPage = (outputDirectory: string, reactApi: ReactApi) => {
},
spread: reactApi.spread,
forwardsRefTo: reactApi.forwardsRefTo,
filename: toGithubPath(reactApi.filename),
filename: toGitHubPath(reactApi.filename),
inheritance: reactApi.inheritance
? {
component: reactApi.inheritance.name,
Expand Down
4 changes: 2 additions & 2 deletions docs/src/modules/components/DemoErrorBoundary.js
Expand Up @@ -8,7 +8,7 @@ import Button from '@mui/material/Button';
* Based on https://github.com/sindresorhus/new-github-issue-url/blob/061fa0ddb7d51f3b96d3a0f6a6bebb196f105a7b/index.js
* with node 8 + IE11 support i.e. not using URL (URLSearchParams.set replaced with Map.set)
*/
function newGithubIssueUrl(options) {
function newGitHubIssueUrl(options) {
const url = `https://github.com/${options.user}/${options.repo}/issues/new`;

const query = Object.keys(options)
Expand Down Expand Up @@ -37,7 +37,7 @@ export default class DemoErrorBoundary extends React.Component {
if (error) {
const title = `[docs] Demo ${name} crashes`;
const searchQuery = encodeURIComponent(`is:issue ${title}`);
const issueLink = newGithubIssueUrl({
const issueLink = newGitHubIssueUrl({
user: 'mui',
repo: 'material-ui',
title,
Expand Down

0 comments on commit 7efc7c5

Please sign in to comment.