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

Organize README a bit better #33

Open
ykdojo opened this issue Jul 24, 2023 · 9 comments
Open

Organize README a bit better #33

ykdojo opened this issue Jul 24, 2023 · 9 comments
Assignees

Comments

@ykdojo
Copy link
Owner

ykdojo commented Jul 24, 2023

Move the API endpoints section into a separate file and add more details about how to get started with Kaguya - install it as a ChatGPT plugin and move all files you want ChatGPT to have access to, to the FILES directory.

@ykdojo
Copy link
Owner Author

ykdojo commented Jul 24, 2023

Related issue: #18

@ThirDecade2020
Copy link
Contributor

Helloooo - so move API endpoints and expanded installation directions (getting started guide) from original README to new README file? How detailed do you want to get when it comes to installation directions, include actual code or more high level info?

@ykdojo
Copy link
Owner Author

ykdojo commented Aug 2, 2023

We added more details since I created this issue, and I feel like it's already at a pretty good state - what do you think?

I think the API endpoints should be in a separate file, but everything else can stay in README.

@ThirDecade2020
Copy link
Contributor

README looks good now with Custom Instructions too can update as time goes on - confused users can consult Discord for help. Stick API endpoints in new README in 'Pages' directory is what I would try. You can assign me here if all good.

@ykdojo
Copy link
Owner Author

ykdojo commented Aug 4, 2023

Stick API endpoints in new README in 'Pages' directory is what I would try.

I'm not sure what you mean here exactly?

@ThirDecade2020
Copy link
Contributor

You mentioned 'I think the API endpoints should be in a separate file, but everything else can stay in README' above so my point was to remove that section from README and create a new README within 'pages' directory of repo where api stuff is located. Maybe I'm confused here.

@ykdojo
Copy link
Owner Author

ykdojo commented Aug 13, 2023

No actually that makes sense! Appreciate the clarification

@ThirDecade2020
Copy link
Contributor

Final decision to leave API endpoints in README, or move to another file in 'Pages' directory? Feel free to assign me if you want to move forward on this.

@ykdojo
Copy link
Owner Author

ykdojo commented Aug 16, 2023

I think moving it to the pages directory makes sense

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

No branches or pull requests

2 participants