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

docs: enhance README with technical architecture details #2

Merged
merged 2 commits into from
Feb 10, 2025

Conversation

minhyeong112
Copy link
Contributor

@minhyeong112 minhyeong112 commented Feb 6, 2025

Copy link
Member

@0x4007 0x4007 left a comment

Choose a reason for hiding this comment

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

I fear this may immediately be out of date because I know we have a large pending pull request.

@whilefoo perhaps you can use cline the vscode extension to regenerate a current readme after merge.

README.md Outdated Show resolved Hide resolved
@0x4007 0x4007 merged commit 029171d into ubiquity-os-marketplace:development Feb 10, 2025
2 of 3 checks passed
@gentlementlegen
Copy link
Member

I really think that paraphrasing the code inside of the docs is very bad practice, and quite useless because it becomes obsolete whenever the code is changed. Linking to the files would be more interesting, instead of copy pasting content (like for the manifest). Also keep in mind these docs appear side by side within our plugin installer, which would show a lot of useless information.

As a dev when I read docs, I expect a quick setup example, an overview of capabilities and how to configure, not what code files do.

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.

Enhance READMEs with technical architecture documentation
3 participants