Skip to content
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.

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

Centralize documentation #4164

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open

Conversation

naskio
Copy link
Contributor

@naskio naskio commented Jan 23, 2025

What type of PR is this?

Documentation

What this PR does / why we need it:

  • Adds missing content files that exist only on the website (gh-pages branch) but not in the docs/ folder.
  • Removes duplicates.
  • Improves folder structure and renames some index.md to README.md to improve browsing in the GitHub UI and IDE.
  • Fixes broken links in markdown files.
  • Consolidates all documentation into a single docs/ folder, making it seamlessly accessible from the GitHub UI, IDE, and usable as content for the website.

Which issue(s) this PR fixes:

Related to #4162

Special notes for your reviewer:

Some files may be outdated, but they have been included in this PR as they exist on the website. This will allow us to decide whether to keep, update or remove them.

naskio added 17 commits January 23, 2025 17:35
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
…uction-install.md

Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
…itecture.md)

Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
…to website/ folder)

Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
…browsing on GitHub)

Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant