-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add - Added CoC and updated index.md
--- We've added code of conduct and updated the index.md for each project so that these files become more relevant. --- Type: add Breaking: False Doc Required: False Backport Required: False Part: 1/1
- Loading branch information
Showing
2 changed files
with
6 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,15 @@ | ||
## What is Nitrocid KS? | ||
|
||
Nitrocid KS is an application which simulates our future-planned kernel as we've imagined it. It has all the usual applications, including filesystem manipulation, kernel mods, basic scripting, and many more awesome features. | ||
|
||
## What is this web page? | ||
|
||
This webpage is not a wiki for the general use of Nitrocid KS; it's an API documentation for mod developers to be used as reference. It constantly gets updated as we push the updates to the main and servicing versions of Nitrocid KS. | ||
This webpage is an API documentation for developers to be used as reference. It constantly gets updated as we push new versions and new APIs, as well as updated documentation. If your IDE supports Intellisense, you don't need to open this web page. | ||
|
||
If you still intend to use a documentation specific to your preferred version of KS, you may refer to the [releases](https://github.com/Aptivi/NitrocidKS/releases) page of the project and download the attached `0.0.x.y-doc.zip` file. | ||
If you still intend to use a documentation specific to your preferred version, you may refer to the [releases](https://github.com/Aptivi/NitrocidKS/releases) page of the project and download the attached `<version>-doc.zip` file. | ||
|
||
To get started using the documentation, select `API Documentation` from the top menu and select a namespace to get a clear overview of the API that Nitrocid KS provides. | ||
To get started using the documentation, select `API Documentation` from the top menu and select a namespace to get a clear overview of the API. | ||
|
||
## Feedback | ||
|
||
If you wish to leave feedback to us about this API reference website, use the [issue tracker](https://github.com/Aptivi/NitrocidKS/issues) of the project. | ||
|
||
If you wish to contribute to the documentation of the API, go to the Nitrocid KS source code and make your improvements there on a draft [Pull Request](https://github.com/Aptivi/NitrocidKS/pulls); we don't support override files that are made by clicking on `Improve this doc`. | ||
|
||
Any meaningful contributions are welcome. | ||
If you wish to contribute to the documentation of the API, go to the project source code and make your improvements there on a draft [Pull Request](https://github.com/Aptivi/NitrocidKS/pulls); we don't support override files that are made by clicking on `Improve this doc`. | ||
|
||
Copyright (c) 2018 - 2024 Aptivi. All rights reserved. | ||
Any meaningful contributions are welcome, as long as they follow the [code on conduct](https://github.com/Aptivi/NitrocidKS/blob/main/CODE_OF_CONDUCT.md) and [contribution guidelines](https://github.com/Aptivi/NitrocidKS/blob/main/CONTRIBUTING.md). |