Skip to content

Commit 7b1ec7d

Browse files
committed
updated readme
1 parent 17378b3 commit 7b1ec7d

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ This documentation site was built using [Jekyll](https://jekyllrb.com/) and the
2323
### Key Guidelines for Contributors
2424
* **Documentation Location:** All content related to Ocre’s documentation lives in the `docs` folder. If you're contributing, focus your efforts here.
2525
* **Editing Scope:** Contributors (who are not maintainers) should avoid editing files outside the `docs` folder. The rest of the structure is primarily for configuration and assets that support the documentation.
26-
* **Assets:** Any images, scripts, or styles related to the documentation should be placed in the `assets` (a subdirectory of `docs`). When adding images, make sure to reference them correctly in your Markdown files.
26+
* **Assets:** The assets directory is reserved for resources that support the site's core functionality, including scripts, styles, and any images referenced by configuration files or top-level pages (such as `_config.yml` and `index.md`). All other documentation-specific images should be stored alongside the documents where they are referenced, keeping resources as close as possible to their usage location.
2727

28-
This structure and these guidelines help ensure the integrity and maintainability of the Ocre documentation site while allowing contributions to focus on content updates.
28+
This structure and these guidelines help ensure the integrity and maintainability of the Ocre documentation site while allowing contributions to focus on content updates. Failure to follow these guidelines may result in rejecting your PR. If you have any questions please reach out to us via [Slack](https://lfedge.slack.com/archives/C07F190CC3X).
2929

3030
## Getting Started
3131

0 commit comments

Comments
 (0)