yacs-rcos / docs Goto Github PK
View Code? Open in Web Editor NEWWelcome to Yacs. We're happy to see you ❤️
Home Page: https://yacs-rcos.github.io/
License: MIT License
Welcome to Yacs. We're happy to see you ❤️
Home Page: https://yacs-rcos.github.io/
License: MIT License
Create Architecture page with diagrams of service-level architecture, and good descriptions of each.
Create a page with instructions and contact info for getting Yacs at your school!
Create a page instructing developers on how to get started contributing to Yacs. This should include key repositories, installation instructions, etc.
I did a readability check of our current documentation as part of the accessibility audit.
As a general guideline, most text should aim for approximately an 8th grade reading level or lower. If that is not possible (e.g. highly technical or academic texts), provide a TL;DR in plain English that is an 8th grade reading level or lower.
The following pages need improvement with regards to readability:
Page | Grade Level | Flesch Reading Ease | Gunning Fog Index |
---|---|---|---|
Repository Map | 9th grade | 54 (fairly difficult to read) | 11.7 (hard to read) |
Code of Conduct (foreword only) | College | 37.6 (difficult to read) | 16.2 (difficult to read) |
Running Yacs (for development) | 9th grade | 59.8 (standard/average) | 11.6 (hard to read) |
All other pages so far are at an 8th grade level or below!
This page should live in the overview section. It should explain the motivation for Yacs, a little about it's history, what problems we are trying to solve, and where the project is heading.
We have many repos, and this can get confusing. We need a page mapping each repo to it's purpose.
The links to the Bylaws and our definition of harassment are broken.
Correct link to bylaws: https://handbook.rcos.io/#/community/bylaws
Correct link to harassment definition: https://handbook.rcos.io/#/community/harassment_guidelines
The documentation should have a table of contents in the beginning, directing different types of documentation users to where they should go, and how the documentation should be read.
From issue 410 which was in the wrong repo
Describe the bug
There is what appears to be a GitHub 404 error.
To Reproduce
Steps to reproduce the behavior:
Go to yacs.io
Click on Projects in the top right corner.
404
Expected behavior
I expect it to bring me here.
The GitHub link is already up there though, so I am not exactly sure where it really should go.
Desktop (please complete the following information):
OS: linux
Browser firefox
Version don't know
TODO from docs/contributors/getting_started.md
On the service map section of the documentation, the links on the sidebar should point to sections of the markdown, not places in the github repo
Create an intro page introducing the project, what it does, and it's goals.
Add Overview section with general information, README, CoC, basic project info
Create documentation for API v6
Create a cover page, welcoming new users to the project.
The page should include:
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.