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

Create introduction index page #27

Open
smckeon-so opened this issue Jan 15, 2025 · 3 comments
Open

Create introduction index page #27

smckeon-so opened this issue Jan 15, 2025 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@smckeon-so
Copy link
Collaborator

smckeon-so commented Jan 15, 2025

Create a new index page with a short introduction paragraphs of what Aranya is and what it can be used for.

@smckeon-so smckeon-so added the documentation Improvements or additions to documentation label Jan 15, 2025
@smckeon-so smckeon-so added this to the Open-Source Aranya Docs milestone Jan 15, 2025
@smckeon-so smckeon-so self-assigned this Jan 15, 2025
@smckeon-so
Copy link
Collaborator Author

smckeon-so commented Jan 15, 2025

Being done as part of #26
This will be it's own PR.

@smckeon-so
Copy link
Collaborator Author

Taken from meeting notes with Caitlin:

We want to update the index to sections and hierarchical. Initial thoughts for the high level sections:

  • Aranya Overview
    • This will include overview and any user guides, etc.
  • Getting Started
    • This is the walkthrough tutorial
  • Example Code and Use Cases
    • We might not have these now, but will want to in the future
  • Specs

Home Page:

Index Overview Blurb is good

For the overview page content:

We will want to update this to align with the subsections we align on above. This is exactly what I was thinking in regard to one sentence on what each item is.

Overall, I think this is the right level of content and we don’t need to add additional detail.

@smckeon-so
Copy link
Collaborator Author

We've pivoted slightly following a work session with Yael to the following.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant