-
Notifications
You must be signed in to change notification settings - Fork 348
Adds minimal permissions to docs pages #6728
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
Conversation
Cool! The permissions page is in #6705 so let's merge it too and then we can include the reference 👏 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances documentation and CLI support by introducing a minimal permissions section for commands, along with tooling to generate it, and updates related configuration and docs.
- Add a permissions section to all Planner command docs and update the sidebar/config accordingly
- Introduce scripts/generate-docs-permissions.mjs to auto-generate the permissions markdown
- Update the CLI and global docs to support a new
permissions
help mode
Reviewed Changes
Copilot reviewed 41 out of 41 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
src/utils/md.ts | Refine regex in convertAdmonitions and adjust tab stripping |
src/m365/planner/commands/tenant/tenant-settings-list.ts | Remove outdated defaultProperties override |
src/m365/planner/commands/tenant/tenant-settings-list.spec.ts | Remove corresponding defaultProperties test |
src/cli/cli.ts | Add 'permissions' to helpModes array |
scripts/generate-docs-permissions.mjs | New script to build permissions markdown tables |
docs/src/config/sidebars.ts | Rename sidebar label from “Help page” to “Docs page” |
docs/docs/contribute/new-command/writing-the-docs.mdx | Update docs guidelines with permissions tooling |
docs/docs/contribute/environment-setup.mdx | Generalize Node.js/npm requirement wording |
docs/docs/cmd//.mdx | Add ## Permissions tabs section across command docs |
docs/docs/cmd/_global.mdx | Extend help output options with permissions |
.eslintrc.cjs | Tweak TS rule configuration for .mjs files |
Comments suppressed due to low confidence (3)
scripts/generate-docs-permissions.mjs:60
- The
header
line lacks the same two-space indentation as thedivider
anddataRows
, causing the table header to misalign. Consider prefixing it with two spaces (e.g.,|${...}
) to match the other rows.
const header = `|${COLS.map((h, i) => cell(h, i)).join('|')}|`;
docs/docs/cmd/planner/tenant/tenant-settings-set.mdx:39
- This document uses
<Tabs>
and<TabItem>
components but does not import them at the top. Addimport Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
before usage.
## Permissions
docs/docs/cmd/planner/task/task-set.mdx:103
- The permissions section introduces
<Tabs>
and<TabItem>
but the MDX does not import these components. Add the imports at the top of the file to avoid build errors.
## Permissions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job @milanholemans! Let’s finally get this out. There’s a merge conflict and a comment I left, but I’ll take care of both during the merge.
@@ -247,7 +247,7 @@ module.exports = { | |||
] | |||
} | |||
], | |||
"@typescript-eslint/explicit-function-return-type": ["error", { "allowExpressions": true }], | |||
"@typescript-eslint/explicit-function-return-type": ["error", { "allowExpressions": true }, ], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I assume this is an accidental change?
"@typescript-eslint/explicit-function-return-type": ["error", { "allowExpressions": true }, ], | |
"@typescript-eslint/explicit-function-return-type": ["error", { "allowExpressions": true }], |
Closes #4399
In this PR: