Documentation Index

[movchan74]

Summary:
This update introduces a central index for documentation and improves the overall structure of the docs folder, making it easier for users to navigate and access information.

Key Changes:

1. New README as docs index: Added a README file to the docs folder, serving as a central index for all documentation pages.
2. Documentation restructure: Moved existing docs pages into a new /docs/pages subfolder for better organization.
3. Logo relocation: Moved logo from the repo's root into docs and used raw.githubusercontent.com URL. It's cleaner. Using a direct URL will also allow displaying the logo on the PyPI page (now it's missing). Note: the link to the logo uses the URL's main branch, so it will only work once we merge the PR.
4. Aana App Template Repo: Added link to aana app template repo.
5. Cluster Setup: Moved from wiki and updated documentation on cluster setup.
6. Documentation fixes: Corrected various minor issues and inaccuracies in the existing documentation.

[appoose]

1. Can you also add https://github.com/mobiusml/aana_sdk/wiki/Cluster-Setup ( maybe move it out of wiki to docs ) and add a section on scaling up the SDK ?
2. There are ways to monitor Ray cluster, and is not apparent. We should probably talk about it somewhere ( not in detail during this version )
3. We should link the videos etc. here. But it can be a part of a different PR later in future.
4. We should also mention about the template. Possibly in the development -> development guide.
5. The seperation of projects and SDK is not apparent.

[movchan74]

1. Can you also add https://github.com/mobiusml/aana_sdk/wiki/Cluster-Setup ( maybe move it out of wiki to docs ) and add a section on scaling up the SDK ?

   2. There are ways to monitor Ray cluster, and is not apparent. We should probably talk about it somewhere ( not in detail during this version )

   3. We should link the videos etc. here. But it can be a part of a different PR later in future.

   4. We should also mention about the template. Possibly in the development -> development guide.

   5. The seperation of projects and SDK is not apparent.

I already mentioned the template.

The seperation of projects and SDK is not apparent.

What do you mean and what do you want me to do about it?

[appoose]

Let us first move existing projects out and then a subsection in getting started section to make it clear

…

On Fri 12. Jul 2024 at 12:06, Aleksandr Movchan ***@***.***> wrote: 1. Can you also add https://github.com/mobiusml/aana_sdk/wiki/Cluster-Setup ( maybe move it out of wiki to docs ) and add a section on scaling up the SDK ? 2. There are ways to monitor Ray cluster, and is not apparent. We should probably talk about it somewhere ( not in detail during this version ) 3. We should link the videos etc. here. But it can be a part of a different PR later in future. 4. We should also mention about the template. Possibly in the development -> development guide. 5. The seperation of projects and SDK is not apparent. I already mentioned the template. The seperation of projects and SDK is not apparent. What do you mean and what do you want me to do about it? — Reply to this email directly, view it on GitHub <#135 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAJL5SMY6ILMDW2MT5HMY7DZL6TDNAVCNFSM6AAAAABKYSXXSGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMRVGI2DSNRZGU> . You are receiving this because your review was requested.Message ID: ***@***.***>

[movchan74]

Let us first move existing projects out and then a subsection in getting started section to make it clear
…
On Fri 12. Jul 2024 at 12:06, Aleksandr Movchan @.> wrote: 1. Can you also add https://github.com/mobiusml/aana_sdk/wiki/Cluster-Setup ( maybe move it out of wiki to docs ) and add a section on scaling up the SDK ? 2. There are ways to monitor Ray cluster, and is not apparent. We should probably talk about it somewhere ( not in detail during this version ) 3. We should link the videos etc. here. But it can be a part of a different PR later in future. 4. We should also mention about the template. Possibly in the development -> development guide. 5. The seperation of projects and SDK is not apparent. I already mentioned the template. The seperation of projects and SDK is not apparent. What do you mean and what do you want me to do about it? — Reply to this email directly, view it on GitHub <#135 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJL5SMY6ILMDW2MT5HMY7DZL6TDNAVCNFSM6AAAAABKYSXXSGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMRVGI2DSNRZGU . You are receiving this because your review was requested.Message ID: @.>

Let us first move existing projects out

I'm working on it but it will be a separate PR. Is there anything you want me to do about it in this PR?

[appoose]

This is good to go

[appoose]

Good to go