diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 716754912..f2eb78ed2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 | @@ -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. \ No newline at end of file +Thank you for your contributions! Your support helps make OpenCloud Docs better for everyone. diff --git a/README.md b/README.md index 7cb62b079..3453a449d 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 @@ -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! \ No newline at end of file +Thanks for helping us keep the docs clean, professional, and easy to read!