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

[docs] Improve feedback precision #34641

Merged
merged 59 commits into from Nov 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
63319ac
first try
alexfauquette Oct 6, 2022
acd727e
customize a bit
alexfauquette Oct 10, 2022
f000559
remove context, only rely on event dispatch
alexfauquette Oct 11, 2022
8bd78cd
Only display buttons when feedback footer is available
alexfauquette Oct 11, 2022
3141e6d
add the hash to the slack message
alexfauquette Oct 11, 2022
56dfe02
manage undefined up/down vote
alexfauquette Oct 11, 2022
d787afc
Merge remote-tracking branch 'upstream/master' into improve-feedbacks
alexfauquette Oct 14, 2022
317907d
remove early thanks
alexfauquette Nov 2, 2022
3fff812
remove section selector
alexfauquette Nov 2, 2022
9915504
make the submit more visible
alexfauquette Nov 2, 2022
27fc469
fix accessibility
alexfauquette Nov 2, 2022
ef60d25
inline CSS
alexfauquette Nov 2, 2022
fa2da76
prettier
alexfauquette Nov 2, 2022
2534cda
Merge remote-tracking branch 'upstream/master' into improve-feedbacks
alexfauquette Nov 2, 2022
6940285
add a link to github issue
alexfauquette Nov 2, 2022
929eb2c
Apply suggestions from code review
alexfauquette Nov 2, 2022
11f33ad
wordings
alexfauquette Nov 9, 2022
36fd434
button alignments
alexfauquette Nov 9, 2022
f79b446
Merge remote-tracking branch 'upstream/master' into improve-feedbacks
alexfauquette Nov 15, 2022
0ea5e20
vertically align
alexfauquette Nov 15, 2022
bf5c0c1
feedbacks
alexfauquette Nov 15, 2022
40beb69
inver call to action and form actions
alexfauquette Nov 15, 2022
26de531
tweak layout
oliviertassinari Nov 20, 2022
a0bc9be
GitHub
oliviertassinari Nov 20, 2022
308595e
avoid style duplication and fix dark mode
oliviertassinari Nov 20, 2022
ec013b4
allow to reset to the whole page
oliviertassinari Nov 20, 2022
8e6a1d7
Merge branch 'master' into improve-feedbacks
oliviertassinari Nov 20, 2022
573facf
Alex's feedback, revert change
oliviertassinari Nov 21, 2022
02c4d0c
[website] Exclude experiment pages in production (#35180)
siriwatknp Nov 21, 2022
3f2e780
[website] Fix theme mode toggle state (#35216)
siriwatknp Nov 21, 2022
edfad73
Bump Font awesome SVG icons to ^6.2.1 (#35207)
renovate[bot] Nov 21, 2022
b9e220f
Bump @types/react-dom to ^18.0.9 (#35206)
renovate[bot] Nov 21, 2022
0d9dc7a
Bump @types/lodash to ^4.14.189 (#35205)
renovate[bot] Nov 21, 2022
1d0c387
Bump @chakra-ui/system to ^2.3.3 (#35204)
renovate[bot] Nov 21, 2022
4f373b9
Bump webpack to ^5.75.0 (#35128)
renovate[bot] Nov 21, 2022
5ff07ba
Bump typescript-eslint to ^5.43.0 (#35127)
renovate[bot] Nov 21, 2022
91a5f74
Bump marked to ^4.2.3 (#35126)
renovate[bot] Nov 21, 2022
85a40ba
Bump danger to ^11.2.0 (#35124)
renovate[bot] Nov 21, 2022
1a4156a
Bump cimg/node Docker tag to v14.21 (#35123)
renovate[bot] Nov 21, 2022
c7f70a8
Bump aws-sdk to ^2.1258.0 (#35121)
renovate[bot] Nov 21, 2022
d921f78
Bump postcss to ^8.4.19 (#35119)
renovate[bot] Nov 21, 2022
b3067cf
Bump loader-utils from 2.0.3 to 2.0.4 (#35186)
dependabot[bot] Nov 21, 2022
4767ba7
[website] Add Security questionnaire in pricing (#35172)
oliviertassinari Nov 21, 2022
5d79e10
Bump babel-loader to ^8.3.0 (#35122)
renovate[bot] Nov 21, 2022
a1e5c37
Bump theme-ui to ^0.15.4 (#35120)
renovate[bot] Nov 21, 2022
cca882e
[docs] Fix confusion in TOCs when reaching scroll bottom (#35214)
oliviertassinari Nov 21, 2022
f9a8b86
[Joy] Uplift introduction demos & make consistent with Base (#34316)
danilo-leal Nov 21, 2022
9a2d5d4
[icons] Update the Material Design icons (#35194)
michaldudak Nov 21, 2022
f409f94
[l10n] Add Urdu (ur-PK) locale (#35154)
MBilalShafi Nov 21, 2022
12d631a
[Material You] Add theme structure & Button component (#34650)
mnajdova Nov 21, 2022
447d0a9
[docs] Change MUI -> Material UI in icons-material's readme (#35220)
michaldudak Nov 21, 2022
4a1af80
Convert icons scripts to ESM (#35101)
Janpot Nov 21, 2022
52a26f2
[Autocomplete] Fix keyboard navigation when using custom popover (#35…
sai6855 Nov 21, 2022
14304e3
[docs] Fix a couple documentation errors (#35217)
danilo-leal Nov 22, 2022
ff98e23
5.10.15 (#35221)
siriwatknp Nov 22, 2022
3e21bc0
typo fix
alexfauquette Nov 22, 2022
e8e009b
Olivier feedbacks
alexfauquette Nov 22, 2022
bd63ff8
Merge remote-tracking branch 'upstream/master' into improve-feedbacks
alexfauquette Nov 23, 2022
fe883b2
make template customizable
alexfauquette Nov 23, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/4.docs-feedback.yml
@@ -0,0 +1,52 @@
name: Docs feedback
description: Improve documentation about MUI Core.
labels: ['status: needs triage', 'support: docs-feedback']
title: '[docs] '
body:
- type: markdown
attributes:
value: |
Please provide a searchable summary of the issue in the title above ⬆️.

Thanks for contributing by creating an issue! ❤️
- type: checkboxes
attributes:
label: Duplicates
description: Please [search the history](https://github.com/mui/material-ui/issues) to see if an issue already exists for the same problem.
options:
- label: I have searched the existing issues
required: true

- type: input
id: page-url
alexfauquette marked this conversation as resolved.
Show resolved Hide resolved
attributes:
label: Related page
description: Which page of the documentation is this about?
placeholder: https://mui.com/material-ui/react-badge/
validations:
required: true

- type: dropdown
attributes:
label: Kind of issue
description: What kind of problem are you facing?
options:
- Unclear explanations
- Missing information
- Broken demonstration
- Other
validations:
required: true

- type: textarea
attributes:
label: Issue description
description: |
Let us know what went wrong when you were using this documentation and what we could do to improve it.
value: |
I was looking for ... and it appears that ...

- type: textarea
attributes:
label: Context 🔦
description: What are you trying to accomplish? What brought you to this page? Your context can help us to come up with solutions that benefit the community as a whole.
Expand Up @@ -3,7 +3,7 @@
<p class="description">@material-ui/pickers was moved to the @mui/lab.</p>

:::info
**Stable package available**: The pickers are not available in `@mui/lab`after `v5.0.0-alpha.89`.
**Stable package available**: The pickers are not available in `@mui/lab` after `v5.0.0-alpha.89`.
They have been moved from `@mui/lab` to the MUI X packages `@mui/x-date-pickers` and `@mui/x-date-pickers-pro`.
To migrate from `@mui/lab` to `@mui/x-date-pickers` you can follow the dedicated [migration guide](/x/react-date-pickers/migration-lab/).
:::
Expand Down
1 change: 1 addition & 0 deletions docs/next.config.js
Expand Up @@ -158,6 +158,7 @@ module.exports = withDocsInfra({
SLACK_FEEDBACKS_TOKEN: process.env.SLACK_FEEDBACKS_TOKEN,
SOURCE_CODE_ROOT_URL: 'https://github.com/mui/material-ui/blob/master', // #default-branch-switch
SOURCE_CODE_REPO: 'https://github.com/mui/material-ui',
GITHUB_TEMPLATE_DOCS_FEEDBACK: '4.docs-feedback.yml',
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm adding this variable because github template will not necessarily have the same name on each repo. For example on X we already have a 4.xxxx.yml template

BUILD_ONLY_ENGLISH_LOCALE: buildOnlyEnglishLocale,
},
// Next.js provides a `defaultPathMap` argument, we could simplify the logic.
Expand Down
8 changes: 8 additions & 0 deletions docs/packages/markdown/parseMarkdown.js
Expand Up @@ -249,6 +249,9 @@ function createRender(context) {
`<a aria-labelledby="${hash}" class="anchor-link-style" href="#${hash}" tabindex="-1">`,
'<svg><use xlink:href="#anchor-link-icon" /></svg>',
'</a>',
`<button title="Post a comment" class="comment-link-style" data-feedback-hash="${hash}">`,
'<svg><use xlink:href="#comment-link-icon" /></svg>',
`</button>`,
`</h${level}>`,
].join('');
};
Expand Down Expand Up @@ -458,6 +461,11 @@ ${headers.components
<symbol id="anchor-link-icon" viewBox="0 0 16 16">
<path d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z" />
</symbol>
</svg>`);
rendered.unshift(`<svg style="display: none;" xmlns="http://www.w3.org/2000/svg">
<symbol id="comment-link-icon" viewBox="0 0 24 24">
<path d="M20 2H4c-1.1 0-1.99.9-1.99 2L2 22l4-4h14c1.1 0 2-.9 2-2V4c0-1.1-.9-2-2-2zM6 14v-2.47l6.88-6.88c.2-.2.51-.2.71 0l1.77 1.77c.2.2.2.51 0 .71L8.47 14H6zm12 0h-7.5l2-2H18v2z" />
</symbol>
</svg>`);

docs[userLanguage] = {
Expand Down
5 changes: 4 additions & 1 deletion docs/src/modules/components/AppLayoutDocs.js
Expand Up @@ -30,6 +30,9 @@ const Main = styled('main', {
[theme.breakpoints.up('lg')]: {
width: 'calc(100% - var(--MuiDocs-navDrawer-width))',
},
'& .markdown-body .comment-link-style': {
display: 'inline-block',
},
}));

const StyledAppContainer = styled(AppContainer, {
Expand Down Expand Up @@ -130,7 +133,7 @@ function AppLayoutDocs(props) {
<ActionsDiv>{location && <EditPage markdownLocation={location} />}</ActionsDiv>
{children}
<NoSsr>
<AppLayoutDocsFooter />
<AppLayoutDocsFooter tableOfContents={toc} />
</NoSsr>
</StyledAppContainer>
</Main>
Expand Down