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

fix(docs): improve onboarding of the project #51

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

jdnichollsc
Copy link

Closes #50

@kespinola
Copy link
Collaborator

This looks great @jdnichollsc appreciate you improving the docs.

How would you update the readme now that onboarding is split out?

CHANGELOG.md Show resolved Hide resolved
docs/onboarding/01-project-overview.md Outdated Show resolved Hide resolved
docs/onboarding/01-project-overview.md Outdated Show resolved Hide resolved
docs/onboarding/01-project-overview.md Outdated Show resolved Hide resolved
@ultravigilante
Copy link

ultravigilante commented Jan 26, 2025

Friendly suggestion: I've been learning about this project over the last week, I think one thing that would help with onboarding is describing how to utilize the metrics built-in to Vixen. I've got Prometheus running, but I'm not seeing anything specific to my program showing up.

I've read the Metrics Support section of the README.md, but it doesn't describe how to collect metrics. Possibly a noob question, if it is I apologize.

edit: Figured it out. In my Vixen.toml in the [metrics] section, I had an invalid config.

[metrics]
endpoint = "http://localhost:9091"
job = "prometheus"
export-interval = 60

is all I needed and it just works now. Pretty simple.

@kespinola
Copy link
Collaborator

Sorry for the delay @ultravigilante. We are finishing up some work and then doing a round of development on Vixen. Top priority for this cycle of work is user documentation.

@jdnichollsc
Copy link
Author

This looks great @jdnichollsc appreciate you improving the docs.

How would you update the readme now that onboarding is split out?

Oh yes, please let me know if you want to see some ideas! I was creating this documentation because I'm learning about RPCs and Solana stuff, and I'm also looking for a new job so I'm improving my knowledge about Solana, and helping with the documentation is a nice way to learn more as well (learning by doing) <3

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.

Improve Project Onboarding and Test Coverage
3 participants