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 project homepage and documentation using docusaurus #39

Merged

Conversation

ykdy3951
Copy link
Member

What type of PR is this?:

documentation, enhancement

What this PR does / why we need it:

This PR aims to set up a project homepage and documentation using Docusaurus.

Which issue(s) this PR fixes:

Fixes #31

Special notes for your reviewer:

Docusaurus is a popular tool for building open source project websites and documentation. It offers a clean, customizable, and easy-to-maintain structure for organizing project content. By leveraging Docusaurus, we can enhance the visibility and accessibility of our project to the community and potential users.

Does this PR introduce a user-facing change?


Additional documentation:


@ykdy3951 ykdy3951 added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 21, 2024
@ykdy3951 ykdy3951 added this to the 0.1.2 milestone Mar 21, 2024
@ykdy3951 ykdy3951 linked an issue Mar 21, 2024 that may be closed by this pull request
cllm-website/blog/2024-03-15-welcome/index.md Outdated Show resolved Hide resolved
cllm-website/blog/authors.yml Outdated Show resolved Hide resolved
cllm-website/docs/commands/set/key.md Outdated Show resolved Hide resolved
cllm-website/docs/getting-started.md Outdated Show resolved Hide resolved
cllm-website/docs/getting-started.md Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add two same gif?

cllm-website/README.md Outdated Show resolved Hide resolved
@devleejb devleejb changed the title 31 create project homepage and documentation using docusaurus Create project homepage and documentation using docusaurus Mar 21, 2024
devleejb and others added 2 commits March 21, 2024 15:43
- change maintainer to owner
- yarn to npm
- add short description in getting-started
- change `API key` to `OpenAI API key`
@ykdy3951 ykdy3951 requested a review from devleejb March 21, 2024 07:13
@devleejb devleejb merged commit e373a75 into main Mar 21, 2024
4 checks passed
@devleejb devleejb deleted the 31-create-project-homepage-and-documentation-using-docusaurus branch March 21, 2024 07:30
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 enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Create project homepage and documentation using Docusaurus
2 participants