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.

Sign up for GitHub

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

Jump to bottom

Update user guide and doc #202

Merged
merged 12 commits into from
Mar 7, 2024
Merged

Update user guide and doc #202

merged 12 commits into from
Mar 7, 2024

Conversation

roman807
Copy link
Collaborator

@roman807 roman807 commented Mar 5, 2024

Updated the documentation, mainly:

- README
- User guide 
    |- Getting started
    |- How to use eva
    |- Tutorials

run with

mkdocs serce

@roman807 roman807 requested review from ioangatop and nkaenzig and removed request for ioangatop March 5, 2024 16:58
nkaenzig
nkaenzig reviewed Mar 6, 2024
View reviewed changes
Copy link
Collaborator

@nkaenzig nkaenzig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks very good. One concern I have is that currently the user has to read too much text to get started. In particular, I think we should make the getting started page as short & concise as possible (I left a comment regarding that below).

docs/index.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/user-guide/getting_started.md Outdated Show resolved Hide resolved
docs/user-guide/how_to_use.md Outdated Show resolved Hide resolved
docs/user-guide/how_to_use.md Show resolved Hide resolved
docs/user-guide/tutorials.md Outdated Show resolved Hide resolved
docs/user-guide/tutorials.md Outdated Show resolved Hide resolved
docs/user-guide/tutorials.md Outdated Show resolved Hide resolved
docs/user-guide/tutorials.md Outdated Show resolved Hide resolved
docs/user-guide/getting_started.md Outdated Show resolved Hide resolved
@roman807 roman807 marked this pull request as draft March 7, 2024 12:05
@roman807 roman807 marked this pull request as ready for review March 7, 2024 13:53
@roman807 roman807 merged commit 82262e2 into main Mar 7, 2024
2 checks passed
@roman807 roman807 deleted the update-user-guide-and-doc branch March 7, 2024 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nkaenzig nkaenzig nkaenzig left review comments

@ioangatop ioangatop ioangatop approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@roman807 @nkaenzig @ioangatop