Skip to content

Commit 169b019

Browse files
gonzolivelygonzolively
committed
updaed readme, and added lychee and typos stuff
1 parent 4e452e1 commit 169b019

9 files changed

Lines changed: 144 additions & 50 deletions

File tree

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ _site/
1313
.jekyll-cache/
1414
.jekyll-metadata
1515

16+
# Ignore lycheecache
17+
.lycheecache
18+
1619
# Ignore folders generated by Bundler
1720
.bundle/
1821
vendor/

‎.lycheeignore‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# This file is utilized by the Lychee link checker to identify which URLs or URL patterns should be omitted during checks.
2+
# Enter each URL or pattern you wish to exclude on a separate line, employing regular expressions for targeted exclusions or glob-style patterns for broader matches.
3+
# Reference: https://github.com/lycheeverse/lychee?tab=readme-ov-file#ignoring-links
4+
#
5+
# NOTE: For file exclusions, please use ".lychee.toml"
6+
#
7+
# Usage:
8+
# - Write full URLs to ignore specific links.
9+
# - Use asterisks (*) as wildcards to match any number of characters.
10+
#
11+
# Example:
12+
# https://example.com/specific-page
13+
# *.example.com/*
14+
http://localhost:4000/

‎.typos.toml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### This configuration file is for typos-cli, a command-line tool designed to detect and correct typos in text files. (Install typos-cli here: https://github.com/crate-ci/typos)
2+
### Add words, identiifers, and regex patterns to this file to be ignored.
3+
### Reference: https://github.com/crate-ci/typos/blob/master/docs/reference.md
4+
5+
# Ignore words
6+
[default.extend-words]
7+
COSE = "COSE"
8+
9+
# Ignore identifiers
10+
[default.extend-identifiers]
11+
12+
#Ignore filetype example
13+
[type.po]
14+
extend-glob = ["*.po"]
15+
check-file = false

‎CONTRIBUTING.md‎

Lines changed: 0 additions & 46 deletions
This file was deleted.

‎README.md‎

Lines changed: 88 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,89 @@
1-
# project-ocre.github.io
1+
# Ocre Documentation
22

3-
Will update soon
3+
4+
## Overview
5+
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.
6+
7+
The live version of the documentation can be viewed at [https://example.com](https://example.com).
8+
9+
## Project Structure and Contribution Guidelines
10+
This documentation site was built using [Jekyll](https://jekyllrb.com/) and the [Just the Docs theme](https://just-the-docs.com/).
11+
12+
### Project File Structure
13+
```
14+
.
15+
├── _docs/ # Documentation files (Markdown format) - main focus for contributors
16+
├── assets/ # Contains images, scripts, and other static assets
17+
├── _config.yml # Site configuration file
18+
├── Gemfile # Ruby dependencies for Jekyll
19+
├── Gemfile.lock # Version lockfile for dependencies
20+
├── README.md # The file you are reading right now
21+
└── _site/ # Auto-generated, do not edit directly (site build output)
22+
```
23+
24+
### Key Guidelines for Contributors
25+
* **Documentation Location:** All content related to Ocre’s documentation lives in the `_docs` folder. If you're contributing, focus your efforts here.
26+
* **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.
27+
* **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.
28+
29+
This structure and these guidelines help ensure the integrity and maintainability of the Ocre documentation site while allowing contributions to focus on content updates.
30+
31+
## Getting Started
32+
33+
### Prerequisites
34+
35+
Ensure you have the following installed on your system:
36+
37+
| Software | Version |
38+
|----------|---------|
39+
| Ruby | ≥ 3.3.2 |
40+
| Bundler | ≥ 2.5.4 |
41+
| Jekyll | ≥ 4.3.0 |
42+
43+
### Setup and Local Development
44+
45+
We encourage contributions to improve the documentation! If you’re looking to update or add content, follow these steps:
46+
47+
1. Fork the repository on GitHub.
48+
2. Clone your forked repo
49+
```bash
50+
git clone https://github.com/your-username/project-ocre.github.io.git
51+
cd project-ocre.github.io
52+
```
53+
3. Install dependencies.
54+
```
55+
bundle install
56+
```
57+
4. Create a new branch for your changes.
58+
```bash
59+
git checkout -b feature/your-feature
60+
```
61+
5. Make your changes. Rembmer to focus on the `_docs` folder for content updates.
62+
6. Preview your changes locally by running:
63+
```bash
64+
bundle exec jekyll serve
65+
```
66+
7. Open your browser and visit http://localhost:4000 to see your changes.
67+
68+
8. Once satisfied with your changes, commit them:
69+
```
70+
git add .
71+
git commit -m "Brief description of your changes"
72+
```
73+
74+
9. Push your changes to your fork:
75+
```
76+
git push origin feature/your-feature-name
77+
```
78+
79+
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.
80+
81+
We'll review your contribution and get back to you as soon as possible. Thank you for helping improve the Ocre documentation!
82+
83+
## License
84+
85+
[Your license information]
86+
87+
## Contact
88+
89+
If you have any questions, feel free to [reach out](https://lfedge.slack.com/archives/C07F190CC3X) on Slack or open an issue for discussion.

‎_config.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ repository: project-ocre/project-ocre.github.io
66
theme: just-the-docs
77

88
### General
9-
favicon_ico: "favicon.ico"
9+
favicon_ico: "assets/favicon.ico"
1010
# Set a path/url to a logo that will be displayed instead of the title
11-
logo: "logo.png"
11+
logo: "/assets/logo.png"
1212
heading_anchors: true
1313
enable_copy_code_button: true
1414
permalink: pretty

favicon.png renamed to assets/favicon.png

File renamed without changes.

logo.png renamed to assets/logo.png

File renamed without changes.

‎lychee.toml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# This configuration file is used by the Lychee link checker to manage settings, including the exclusion of specific directories and files from being checked.
2+
# Directories and file paths to be excluded are specified under the 'exclude' setting, utilizing glob patterns for matching. This allows for more precise control over the scope of the link checking process.
3+
# Reference: https://github.com/lycheeverse/lychee?tab=readme-ov-file#ignoring-links
4+
5+
# NOTE: For URL and URL pattern exclusions, please use ".lycheeignore"
6+
7+
# Exclude filesystem paths from checking
8+
exclude_path = [
9+
".git",
10+
".github",
11+
"_site",
12+
"Gemfile",
13+
"Gemfile.lock",
14+
"package-lock.json"
15+
]
16+
17+
# Max concurrency
18+
max_concurrency = 10
19+
20+
# Cache settings
21+
cache = true
22+
max_cache_age = "1d"

0 commit comments

Comments
 (0)