Skip to content

Update Documentation Format and Labels #1157

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

Merged
merged 2 commits into from
Dec 4, 2024
Merged

Update Documentation Format and Labels #1157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9b4f8c
Update docs_audit_results.md
Dahka2321 Dec 3, 2024
1f9fa33
Update content-reuse.md
Dahka2321 Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/docs_audit_results.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Docs audit results
about: Template for a formal technical documentation audits run by OP Labs
title: "[2024 Q4 Audit] [page-path]"
labels: 'docs-audit-2024-Q4,op-labs'
labels: ['docs-audit-2024-Q4', 'op-labs']
---

<!-- this template is intended for internal OP Labs usage -->
Expand Down
4 changes: 2 additions & 2 deletions notes/content-reuse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Create a `.md` file in the `/content` directory.
import DescriptionShort from '@/content/DescriptionShort.md'
```

1. Use it within the file
2. Use it within the file

```
Text before
Expand All @@ -38,7 +38,7 @@ export { default as ComponentA } from './ComponentA.md'
export { default as ComponentB } from './ComponentB.md'
```

1. Import it at the top of `.mdx` file:
2. Import it at the top of `.mdx` file:

```
import {ComponentA, ComponentB} from '@/content/index.js'
Expand Down
Loading