avdan-os / docsite Goto Github PK

Issue:
On the AvdanOS Design Guidelines page, there is a large blank area disrupting the content.

Expectation:
There is not a large blank area, either due to it not being there or content filling the area (probably the latter).

Evidence:

Also affects desktop.
Opera GX:

Chrome:

MS Edge:

Docusaurus 2 has support for Markdown. I think that it would make writing the docs simpler if we start using Markdown now while it's still in it's early stages.

Setup a faq page under the docs tab

To-Dos from @LinuxJava7:

• Separate Design, Code, and (General Documentation) more clearly — perhaps into different sections.
• Update Rust code guidelines, and general introduction to Navda to focus on implementation.

Issue:
On the AvdanOS Design Guidelines page, the YouTube video embed stretches too far, causing a horizontal scroll bar to appear.
This issue also seems to affect the AvdanOS Overview page.

Expectation:
The YouTube video embed reacts to the size of the viewport by shrinking so the browser does not show the horizontal scroll bar.

Evidence:
AvdanOS Guidelines:

AvdanOS Overview:

Considering that I've stopped working on this project, at least for a couple of months, all the pages that I've marked with "TODO" are now stuck in an unfinished state.

For anyone who wants to finish those pages, the references were taken from the Notion page, which is located in the Discord server (not sure if the server still has the vanity invite link). It's basically copy and pasted from Notion. You just need to find the correct page, add the links to other pages and there you have it. You can talk to other server members like Sammy99jsp about how to do this stuff.

Might be a useless issue, but I wanted to put this out there for those are wondering "why are there so many danger signs that say that some dude who isn't active hasn't finished it yet?"

Notion Site will be the base for the doc site
Also the same time StoneMc Goos and Padmanabh is working on the doc site as well as intergrations

• Rename all non-matching dirctory/documents to use kebab-case
• Add "Use kebab-case" to the doc writing guidelines.

Not sure why the readme.md says to use yarn please use mark down. I will update the readme during weekly dev team development sessions

I Created A new doc called webpage everything is fine but except when I click on the navbar link gives an error:
.

To View, The Code Please check My fork:
https://github.com/Rohith0009/docsite

Issue:
On the main page for the Docs website, the list of features has inconsistent spacing.

Expectation:
Consistent spacing.

Evidence:

I Am Working On A Translation feature on docsite when I run npm run build i am facing this error

Just forked the repo and when running yarn, I get this:

yarn install v1.22.10
warning package-lock.json found. Your project contains lock files generated by tools other than Yarn. It is advised not to mix package managers in order to avoid resolution inconsistencies caused by unsynchronized lock files. To clear this warning, remove package-lock.json.
[1/4] Resolving packages...
[2/4] Fetching packages...
error An unexpected error occurred: "C:\\Users\\moham\\AppData\\Local\\Yarn\\Cache\\v6\\npm-type-fest-2.16.0-integrity\\node_modules\\type-fest\\.yarn-metadata.json: Unexpected end of JSON input".
info If you think this is a bug, please open a bug report with the information provided in "D:\\Actual Projects\\AvdanOS\\docsite\\yarn-error.log".
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command

As I Have Added the App section more content is required for most of the apps. So I would like a good writer to complete those. As Of now, the apps section is only a PR #100 After it gets merged. Then whomever can add the content. Thanks.
I have only added the content which is present in the notion.

The docsite uses light theme by default and now I'm blind...