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

[Issue]: README.md series issues #88

Open
1 of 5 tasks
Aisuko opened this issue Sep 25, 2024 · 7 comments
Open
1 of 5 tasks

[Issue]: README.md series issues #88

Aisuko opened this issue Sep 25, 2024 · 7 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Aisuko
Copy link
Contributor

Aisuko commented Sep 25, 2024

Contact Details(optional)

These aren't the tasks that related to Coding. These tasks will help you familiar to how to maintain an open-source project.

What is the issue you are having?

  • 1. Setup and API usage demo video should be relocated to the top of the "BUILD&RUN" section. And "Setup and API usage demo video" should be replaced by "# Demo video" @ZYLIII
  • 2. Replace "CLI" to "# How to use CLI tool to configure the project" @ZooHigher26 Update README.md #90
  • 3. Add a new title "# Build & Setup" for "Local Machine" and "Container" sections
  • 4.Move "Lint" section to the Devlopment.md(create new one if it doesn't exist) @knframe2
  • 5. Add License to the bottom of the README.md

Relevant log output

No response

@Aisuko Aisuko added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Sep 25, 2024
@knframe2
Copy link
Contributor

I'll take task 4.

@ZooHigher26
Copy link
Collaborator

I'll take task 2

@ZYLIII
Copy link
Contributor

ZYLIII commented Sep 25, 2024

I'll take 1

@ZooHigher26 ZooHigher26 mentioned this issue Sep 28, 2024
1 task
@ZooHigher26
Copy link
Collaborator

I can take task 3 if no one else is doing it already

@ZYLIII
Copy link
Contributor

ZYLIII commented Oct 8, 2024

Can you clarify more about task 1? Should I delete the Setup and API usage demo video part and move the video to the Demo video part before the BUILD & RUN as the picture I attached?

image

@Aisuko
Copy link
Contributor Author

Aisuko commented Oct 8, 2024

Can you clarify more about task 1? Should I delete the Setup and API usage demo video part and move the video to the Demo video part before the BUILD & RUN as the picture I attached?

image

YES

ZYLIII added a commit to ZYLIII/voyager that referenced this issue Oct 9, 2024
…demo video and update build instructions

Signed-off-by: youname <[email protected]>
@Aisuko Aisuko mentioned this issue Oct 9, 2024
1 task
cbh778899 pushed a commit that referenced this issue Oct 9, 2024
…o and update build instructions (#91)

Signed-off-by: youname <[email protected]>
@Aisuko
Copy link
Contributor Author

Aisuko commented Oct 10, 2024

I can take task 3 if no one else is doing it already

Feel free to do it

@ZooHigher26 ZooHigher26 mentioned this issue Oct 15, 2024
1 task
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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants