Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MG-8 - Add Developer Sidebar and Quick Start Guide #23

Merged
merged 9 commits into from
Feb 13, 2025

Conversation

Musilah
Copy link
Contributor

@Musilah Musilah commented Feb 6, 2025

Pull request title should be MG-XXX - description or NOISSUE - description where XXX is ID of issue that this PR relate to.
Please review the CONTRIBUTING.md file for detailed contributing guidelines.

What does this do?

  • Adds a developer's guide sidebar to the documentation
  • Adds the getting started guide for developers using CLI
  • Updates the CLI documentation
  • Restructures the Getting Started flow
  • Update Entities file

Which issue(s) does this PR fix/relate to?

Related to #8

List any changes that modify/break current functionality

Have you included tests for your changes?

Did you document any new/modified functionality?

Notes

image

Signed-off-by: Musilah <[email protected]>
Signed-off-by: Musilah <[email protected]>
Signed-off-by: Musilah <[email protected]>
Signed-off-by: Musilah <[email protected]>
@Musilah Musilah marked this pull request as ready for review February 11, 2025 02:43
Signed-off-by: Musilah <[email protected]>
@ianmuchyri
Copy link
Contributor

ianmuchyri commented Feb 11, 2025

Let's have this here:
image

As well as an external link to the api docs

Also try out with User Docs and Dev Docs, see if they look better. These ones seem too long. But I don't know what the convention is

@ianmuchyri
Copy link
Contributor

ianmuchyri commented Feb 11, 2025

Also can we split docs into two,

  1. user
  2. dev

So say endpoints for clients in users will be /user/clients then for developer docs will be /dev/clients.
It will also make it easy to know which docs are for user-docs and which are for dev-docs

@Musilah Musilah changed the title MG-8 - Add Developer Sidebar MG-8 - Add Developer Sidebar and Quick Start Guide Feb 11, 2025
Signed-off-by: Musilah <[email protected]>
@ianmuchyri
Copy link
Contributor

  1. Can we have the title as Introduction as well
    image

  2. Should we be using specific people names? Like celebrities for example
    image

  3. We should also talk about clients and channels management using the cli
    image

  4. Also within a particular management we seem to be missing roles, and user management in details. Or is this not supported by the cli?
    image

  5. This section isn't up to date. All these are individual services under the new architecture. Check on that. This may necessitate an pr on it's own as it involves a lot . The structs have also changed. Also I think this file should come second after getting started, so the user knows the entities they are working with.
    image

Signed-off-by: Musilah <[email protected]>
Signed-off-by: Musilah <[email protected]>
@ianmuchyri
Copy link
Contributor

  1. Is role meant to be under users, or on it's own?
    image

  2. Only users have roles
    image

  3. Just have it as Overview
    image

  4. Just Introduction is enough
    image

  5. Move Entities to just after getting started
    image

@ianmuchyri ianmuchyri merged commit dc81972 into absmach:main Feb 13, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants