Skip to content

Commit

Permalink
Update index.md
Browse files Browse the repository at this point in the history
Pointed newcomers to the appropriate documentation
  • Loading branch information
Arawn-Davies authored Jun 7, 2021
1 parent fbc3bf6 commit 8fe8164
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions Docs/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# Cosmos Documentation

<br />

Some docs are outdated, and we are currently working on updating them and adding new ones.

<br />

*Looking for the [Cosmos website](https://gocosmos.org)?*
# Welcome to the Official Cosmos Documentation</h1>

If you're knew to Cosmos, welcome! Before you get stuck in the API documentation, we highly recommend you visit the website linked at the bottom.

The Articles section of this website includes some articles which have been written many years ago for websites such as www.codeproject.com and are kept for archival purposes. These discuss elements such as the Cosmos Virtual FIle System. We prefer newcomers who want to develop their own operating systems to read the API documentation while we update these articles to comply with the current Cosmos project.

For projects using the VFS directly, we recommend you use System.IO methods where possible. This is because these were written before much progress was made making .NET assemblies usable


For the up-to-date API documentation generated from the master branch, please visit the [Cosmos API Documentation](https://cosmosos.github.io/api/Cosmos.Build.Tasks.html)

If you're looking for general information about Cosmos e.g. our goals and various links to chat with us or for help with using Cosmos that can't be answered with existing documentation, please visit the [Cosmos website](https://gocosmos.org)

0 comments on commit 8fe8164

Please sign in to comment.