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

feat: Create community section #745

Merged
merged 4 commits into from
Dec 1, 2024
Merged

feat: Create community section #745

merged 4 commits into from
Dec 1, 2024

Conversation

madjin
Copy link
Collaborator

@madjin madjin commented Dec 1, 2024

Demo: https://madjin.github.io/eliza/

Cleaned up docs, removed old pages, moved community section to new tab

It also contains summarized notes from discord chat logs

image

image

also adding page for github contributors

image

Copy link
Contributor

@sirkitree sirkitree left a comment

Choose a reason for hiding this comment

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

Other than the comment above I think this looks great and is a very good addition to the docs. Just make sure that above change to your fork is intentional, but it seems like a mistake.

It is a lot. Which makes me wonder if we may want to have these docs in a separate repo at some point in the near future. Thinking perhaps we'd keep the docs here focused on eliza the tech, and have more of the community-type docs in another repo - this would complicate things though... so maybe not.

@@ -6,4 +6,4 @@

## Defined in

[packages/core/src/parsing.ts:41](https://github.com/ai16z/eliza/blob/main/packages/core/src/parsing.ts#L41)
[packages/core/src/parsing.ts:41](https://github.com/madjin/eliza/blob/main/packages/core/src/parsing.ts#L41)
Copy link
Contributor

Choose a reason for hiding this comment

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

All changes up to here now point to your fork instead of the ai16z repo - is that intentional?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

no def not intentional, will fix - thanks!

@madjin
Copy link
Collaborator Author

madjin commented Dec 1, 2024

Other than the comment above I think this looks great and is a very good addition to the docs. Just make sure that above change to your fork is intentional, but it seems like a mistake.

It is a lot. Which makes me wonder if we may want to have these docs in a separate repo at some point in the near future. Thinking perhaps we'd keep the docs here focused on eliza the tech, and have more of the community-type docs in another repo - this would complicate things though... so maybe not.

I think a good defense for keeping docs here is that we're autogenerating the API docs with the markdown-typedoc plugin. That and if we do a good job with docs, people can use tools like https://github.com/raphaelmansuy/code2prompt to ingest docs to give enough context for a LLM to help them solve issues or create new features all in the same repo.

@lalalune
Copy link
Member

lalalune commented Dec 1, 2024

I agree, let's keep docs in for now. What we can do is also make an auto docs branch that builds docs separately so we don't need to commit the changes to generated docs

@lalalune lalalune merged commit 6e222df into elizaOS:main Dec 1, 2024
2 checks passed
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

Successfully merging this pull request may close these issues.

3 participants