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

Host documentation #33

Open
ivinjabraham opened this issue Feb 8, 2025 · 5 comments
Open

Host documentation #33

ivinjabraham opened this issue Feb 8, 2025 · 5 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@ivinjabraham
Copy link
Member

Having documentation (cargo doc) hosted on GitHub pages would be convenient for devs working on/with amD.

@ivinjabraham ivinjabraham added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 8, 2025
@hrideshmg hrideshmg moved this to Needs Discussion in CMS Tasks Feb 16, 2025
@hrideshmg hrideshmg moved this from Needs Discussion to Backlog in CMS Tasks Feb 16, 2025
@BRGOVIND
Copy link

BRGOVIND commented Mar 4, 2025

can i work on it ?

@ivinjabraham
Copy link
Member Author

Sure!

@BRGOVIND
Copy link

BRGOVIND commented Mar 4, 2025

can u guide me through this brother ?
i am new to open source and rust

@ivinjabraham
Copy link
Member Author

Yeah, I can help you get started. This doesn't need any Rust experience. You'd have to make a GitHub Actions file that automatically deploys the documentation generated with the command cargo doc to our GitHub page. We haven't set up the page yet, and that's something only we can do from our side. I'll do that once the workflow (the GitHub Actions file that I mentioned) is set up.

If you're confused, just prompt GPT to help you out. This is a fairly simple task and it should be able to precisely answer all your questions.

@BRGOVIND
Copy link

BRGOVIND commented Mar 4, 2025

thanks bro, I'll try to make a PR by tomorrow

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 good first issue Good for newcomers
Projects
Status: Backlog
Development

No branches or pull requests

2 participants