re-worked site to use docs folder

Author: gonzolively

README.md

@@ -4,27 +4,26 @@
 ## Overview
 This repository contains the documentation for [Ocre](https://lfedge.org/projects/ocre/). This repo hosts the code for the Ocre docs site, which is separate from the main Ocre project repository.
 
-The live version of the documentation can be viewed at [https://example.com](https://example.com).
+The live version of the documentation can be viewed at: [https://example.com](https://example.com).
 
 ## Project Structure and Contribution Guidelines
 This documentation site was built using [Jekyll](https://jekyllrb.com/) and the [Just the Docs theme](https://just-the-docs.com/).
 
 ### Project File Structure
 ```
-.
-├── _docs/                # Documentation files (Markdown format) - main focus for contributors
-├── assets/               # Contains images, scripts, and other static assets
-├── _config.yml           # Site configuration file
-├── Gemfile               # Ruby dependencies for Jekyll
-├── Gemfile.lock          # Version lockfile for dependencies
-├── README.md             # The file you are reading right now
-└── _site/                # Auto-generated, do not edit directly (site build output)
+├── docs/                  # Contains all markdown files for documentation
+│   └── assets/            # Holds images, CSS, JS, etc. for the documentation
+├── _config.yml            # Jekyll configuration file, maintainers manage this
+├── Gemfile                # Dependencies for Jekyll site, maintainers manage this
+├── Gemfile.lock           # Locked dependencies, maintainers manage this
+├── README.md              # You're reading this file
+└── _site/                 # Auto-generated, do not edit directly (site build output)
 ```
 
 ### Key Guidelines for Contributors
-* **Documentation Location:** All content related to Ocre’s documentation lives in the `_docs` folder. If you're contributing, focus your efforts here.
-* **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.
-* **Assets:** Any images, scripts, or styles related to the documentation should be placed in the assets folder. When adding images, make sure to reference them correctly in your Markdown files.
+* **Documentation Location:** All content related to Ocre’s documentation lives in the `docs` folder. If you're contributing, focus your efforts here.
+* **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.
+* **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.
 
 This structure and these guidelines help ensure the integrity and maintainability of the Ocre documentation site while allowing contributions to focus on content updates.
 
@@ -58,7 +57,7 @@ We encourage contributions to improve the documentation! If you’re looking to
     ```bash
     git checkout -b feature/your-feature
     ```
-5. Make your changes. Rembmer to focus on the `_docs` folder for content updates.
+5. Make your changes. Rembmer to focus on the `docs` folder for content updates.
 6. Preview your changes locally by running:
     ```bash
     bundle exec jekyll serve
@@ -76,7 +75,7 @@ We encourage contributions to improve the documentation! If you’re looking to
     git push origin feature/your-feature-name
     ```
 
-10. Go to the main [Ocre docs repository](https://github.com/project-ocre/project-ocre.github.io) and submit a pull request with a clear description of your changes.
+10. Go to the main [Ocre docs repository](https://github.com/project-ocre/project-ocre.github.io) and submit a [pull request](https://github.com/project-ocre/project-ocre.github.io/pulls) with a clear description of your changes.
 
 We'll review your contribution and get back to you as soon as possible. Thank you for helping improve the Ocre documentation!
 

_config.yml

@@ -6,13 +6,24 @@ repository: project-ocre/project-ocre.github.io
 theme: just-the-docs
 
 ### General
-favicon_ico: "assets/favicon.ico"
-# Set a path/url to a logo that will be displayed instead of the title
-logo: "/assets/logo.png"
+# Serve site from docs
+source: docs
+destination: _site
+favicon_ico: "/assets/images/favicon.png"
+logo: "/assets/images/logo.png"
+# Misc
 heading_anchors: true
 enable_copy_code_button: true
 permalink: pretty
 
+### Defaults paths/content types
+defaults:
+  - scope:
+      path: "docs" # an empty string here means all files in the project
+      type: "pages"
+    values:
+      layout: "default"
+
 ### Exclude files from build
 exclude:
   - .DS_Store
@@ -73,6 +84,11 @@ callouts:
     title: Warning
     color: red
 
+### Sidebar
+nav_external_links:
+  - title: Ocre Docs on GitHub
+    url: https://github.com/project-ocre/project-ocre.github.io
+
 ### Header
 aux_links:
   "Ocre Docs on GitHub":
@@ -87,9 +103,9 @@ back_to_top_text: "Back to top"
 footer_content: 'Copyright &copy; 2024 Contributors to Project Ocre, which has been established as <a href="https://lfedge.org/projects/ocre"> Project Ocre a Series of LF Projects</a>, LLC. Distributed by an <a href="https://github.com/project-ocre/project-ocre.github.io/blob/main/LICENSE.txt">Apache 2.0 License.</a>'
 
 #"Edit this page on GitHub" link text
-gh_edit_link: true # show or hide edit this page link
-gh_edit_link_text: "Edit this page on GitHub"
-gh_edit_repository: "https://github.com/project-ocre/project-ocre.github.io" # the github URL for your repo
-gh_edit_branch: "main" # the branch that your docs is served from
+#gh_edit_link: true # show or hide edit this page link
+#gh_edit_link_text: "Edit this page on GitHub"
+#gh_edit_repository: "https://github.com/project-ocre/project-ocre.github.io" # the github URL for your repo
+#gh_edit_branch: "main" # the branch that your docs is served from
 # gh_edit_source: docs # the source that your files originate from
-gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
+#gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately