Skip to content

add img folder structure to the readme and contributing.md #1186

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
Heiko-Pohl merged 1 commit into from
Sep 25, 2026
Merged

add img folder structure to the readme and contributing.md #1186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Navigate to the original repository and click the "New Pull Request" button. Pro
- Icons & Buttons: Highlight UI elements such as the “+ New” button and the three-dot menu.
- Action-Oriented Phrasing: Use verbs like 'Click,' 'Select,' 'Enter,' and 'Confirm' to encourage user interaction.
- Code-Like Formatting: Uses inline code or UI-style highlights for menu options.
- Screenshots should highlight important aspects, and you may use red frames to emphasize specific buttons or areas.
- Follow the image directory structure and naming conventions described in the [Screenshot Guidelines](README.md#screenshot-guidelines).
- Defined sizes for screenshots:

| content | size |
Expand All @@ -108,4 +108,4 @@ Label Pull Requests with the fitting label (choose one):
- Docs:Guides
- Docs:Build&Tools

Thank you for your contributions! Your support helps make OpenCloud Docs better for everyone.
Thank you for your contributions! Your support helps make OpenCloud Docs better for everyone.
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@ If you're using GitHub Pages, this will push the production build to the `gh-pag
| Menu | 400px |
| Pop-up / Modal | 500px |

> Highlight key elements in the screenshot with red borders or boxes if needed.

### Example

To include a screenshot in your documentation, use the following format:
Expand All @@ -85,6 +83,14 @@ To include a screenshot in your documentation, use the following format:
- Use `require(...)` for image paths so they are bundled correctly by Docusaurus
- Always include a meaningful `alt` text to improve accessibility and SEO

### Image Directory Structure

- Store images in the `img` directory of the corresponding documentation area.
- Mirror the documentation structure below `img` as closely as possible.
- Do not create an additional `index` directory for images used by an `index.md` page.
- Place area-specific or topic-specific images in the corresponding subdirectory.
- Place shared images in a clearly named common directory.
- Use lowercase, descriptive, kebab-case filenames without spaces.

## Markdown Guidelines

Expand Down Expand Up @@ -171,4 +177,4 @@ These commands will:
- Lint and auto-fix markdown formatting
- Ensure consistent style across documentation

Thanks for helping us keep the docs clean, professional, and easy to read!
Thanks for helping us keep the docs clean, professional, and easy to read!
Loading