continue improving docs

mlcommons · Aug 27, 2020 · aabb8d9 · aabb8d9
1 parent 738ac83
commit aabb8d9
Show file tree

Hide file tree

Showing 15 changed files with 241 additions and 146 deletions.
diff --git a/README.md b/README.md
@@ -11,18 +11,18 @@ Coverage: [![Coverage Status](https://coveralls.io/repos/github/ctuning/ck/badge
 
 ## Overview
 
-Collective Knowledge framework (CK) helps to organize any project
+Collective Knowledge framework (CK) helps to organize any software project
 as a database of reusable components with common automation actions
-and extensible meta descriptions based on [FAIR principles](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC4792175)
+and extensible meta descriptions based on [FAIR principles](https://www.nature.com/articles/sdata201618)
 (findability, accessibility, interoperability, and reusability).
 
 The ultimate goal is to help everyone share, reuse, and extend their knowledge
 in the form of reusable artifacts and portable workflows with a common API, CLI,
 and JSON meta description. 
 
-See some real-world use cases from Arm, General Motors, IBM, MLPerf, the Raspberry Pi foundation, 
-and ACM to support collaborative and reproducible AI, ML, and systems R&D 
-at https://cKnowledge.org/partners.
+See how CK helps to support collaborative and reproducible AI, ML, and systems R&D
+in some real-world use cases from Arm, General Motors, IBM, MLPerf, the Raspberry Pi foundation, 
+and ACM at [cKnowledge.org/partners](https://cKnowledge.org/partners.html).
 
 ## News
 
@@ -51,10 +51,24 @@ at https://cKnowledge.org/partners.
   to accelerate the development and adoption of innovative technology -
   get in touch with [Grigori Fursin](https://cKnowledge.io/@gfursin) (CK author and project leader) to know more!*
 
+## Documentation
+
+* [Online CK documentation (under construction)]( https://ck.readthedocs.io ) 
+* [CK Basics](https://michel-steuwer.github.io/About-CK)
+* [Try CK](https://github.com/ctuning/ck/wiki/First-steps)
+* [CK Wiki]( https://github.com/ctuning/ck/wiki )
+
+* [Open CK portal with all CK components, workflows, and live dashboards](https://cKnowledge.io) 
+
+* [Real-world use-cases](https://cKnowledge.org/partners)
+* [Publications](https://github.com/ctuning/ck/wiki/Publications)
+
 ## Installation
 
 Follow [this guide](https://ck.readthedocs.io/en/latest/getting-started/installation.html) 
 to install CK framework on your platform.
+Follow [this guide](https://github.com/ctuning/ck/wiki/First-steps)
+to try CK.
 
 CK supports the following platforms:
 
@@ -69,17 +83,6 @@ CK supports the following platforms:
 | iOS           | TBD | TBD |
 | Bare-metal (edge devices)   | - | ± |
 
-## Documentation
-
-* [CK Basics](https://michel-steuwer.github.io/About-CK)
-* [CK Wiki](https://github.com/ctuning/ck/wiki)
-
-* [Online CK documentation (under construction)](https://ck.readthedocs.io) 
-* [Open CK portal with all CK components, workflows, and live dashboards](https://cKnowledge.io) 
-
-* [Real-world use-cases](https://cKnowledge.org/partners)
-* [Publications](https://github.com/ctuning/ck/wiki/Publications)
-
 ## Author
 
 * [Grigori Fursin](https://cKnowledge.io/@gfursin) ([cTuning foundation](https://cTuning.org) and [cKnowledge SAS](https://www.linkedin.com/company/cknowledge))
diff --git a/docs/index.rst b/docs/index.rst
@@ -9,7 +9,7 @@ CK framework documentation
 
 .. epigraph::
 
-Collective Knowledge framework (CK) helps you to organize your project
+Collective Knowledge framework (CK) helps to organize any software project
 as a database of reusable components with common automation actions
 and extensible meta descriptions based on FAIR principles
 (findability, accessibility, interoperability, and reusability).
@@ -18,31 +18,31 @@ The ultimate goal is to help everyone share, reuse, and extend their knowledge
 in the form of reusable artifacts and portable workflows with a common API, CLI,
 and JSON meta description. 
 
-See some real-world use cases from Arm, General Motors, IBM, MLPerf, the Raspberry Pi foundation, 
-and ACM to support collaborative and reproducible AI, ML, and systems R&D 
-at https://cKnowledge.org/partners.
+See how CK helps to support collaborative and reproducible AI, ML, and systems R&D
+in some real-world use cases from Arm, General Motors, IBM, MLPerf, the Raspberry Pi foundation, 
+and ACM: https://cKnowledge.org/partners.
 
 .. toctree::
    :maxdepth: 2
    :caption: Introduction
 
-   intro/introduction
-   intro/feedback
-   intro/acknowledgments
+   src/introduction
+   src/feedback
+   src/acknowledgments
 
 .. toctree::
    :maxdepth: 2
    :caption: Getting Started
 
-   getting-started/installation
+   src/installation
+   src/getting-started
 
 .. toctree::
    :maxdepth: 2
    :caption: User Guide
 
-   guide/commands
-   guide/use-cases
-   guide/how-to-contribute
+   src/commands
+   src/how-to-contribute
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/intro/introduction.md b/docs/intro/introduction.md
diff --git a/docs/intro/acknowledgments.md → docs/src/acknowledgments.md b/docs/intro/acknowledgments.md → docs/src/acknowledgments.md
diff --git a/docs/guide/commands.md → docs/src/commands.md b/docs/guide/commands.md → docs/src/commands.md
@@ -3,7 +3,6 @@
 We plan to rewrite this documentation when we have more resources. 
 In the mean time have a look at this older wiki-based documentation:
 
-* [CK basics](https://michel.steuwer.info/About-CK)
 * [CK Getting Started Guide](https://github.com/ctuning/ck/wiki/First-steps)
-* [Contributing to CK](https://github.com/ctuning/ck/wiki/Adding-new-workflows)
+* [CK basics](https://michel.steuwer.info/About-CK)
 * [CK wiki](https://github.com/ctuning/ck/wiki)
diff --git a/docs/intro/feedback.md → docs/src/feedback.md b/docs/intro/feedback.md → docs/src/feedback.md
diff --git a/docs/src/getting-started.md b/docs/src/getting-started.md
@@ -0,0 +1,6 @@
+# First steps
+
+* [First steps](https://github.com/ctuning/ck/wiki/First-steps)
+* [Adding your repository and components](https://github.com/ctuning/ck/wiki/Adding-new-workflows)
+
+* [CK wiki](https://github.com/ctuning/ck/wiki)
diff --git a/docs/guide/how-to-contribute.md → docs/src/how-to-contribute.md b/docs/guide/how-to-contribute.md → docs/src/how-to-contribute.md
diff --git a/docs/getting-started/installation.md → docs/src/installation.md b/docs/getting-started/installation.md → docs/src/installation.md
@@ -1,4 +1,4 @@
-# CK framework installation
+# CK installation
 
 You can install the Collective Knowledge framework on most platforms using PIP as follows: