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.

Sign up for GitHub

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

Jump to bottom

Documentation site #113

Open
joshuasing opened this issue Jul 8, 2022 · 2 comments
Open

Documentation site #113

joshuasing opened this issue Jul 8, 2022 · 2 comments
Assignees
@joshuasing
Labels
contributor: needs feedback Feedback is wanted before these changes are merged size: XL type: documentation This involves updating, adding or removing javadoc or other documentation type: feature This adds a new feature

Comments

@joshuasing
Copy link
Member

To make Chameleon easier to use, I think a documentation site made with Vitepress would probably be best.
This could be done in either a docs/ directory in this repository or in a separate repository.
@joshuasing joshuasing added type: documentation This involves updating, adding or removing javadoc or other documentation type: enhancement This is a feature request or a pull request that adds a feature labels Jul 8, 2022
@joshuasing joshuasing added this to the 1.0.0 milestone Jul 8, 2022
@joshuasing joshuasing self-assigned this Jul 8, 2022
@joshuasing joshuasing mentioned this issue Aug 20, 2022
Closed
@joshuasing joshuasing added the status: in progress This is being actively worked on label Aug 29, 2022
@joshuasing joshuasing added status: help wanted contributor: needs corrections These changes need corrections before they can be merged contributor: needs feedback Feedback is wanted before these changes are merged and removed status: help wanted labels Oct 6, 2022
@joshuasing joshuasing added type: feature This adds a new feature and removed contributor: wanted status: in progress This is being actively worked on contributor: needs corrections These changes need corrections before they can be merged type: enhancement This is a feature request or a pull request that adds a feature labels Sep 8, 2023
@joshuasing joshuasing modified the milestones: v1.0.0, v0.20.0 Sep 23, 2023
@aditya4567uk
Copy link

I am eager to contribute , can I maintain or contribute with documentation part?

@joshuasing
Copy link
Member Author

I am eager to contribute , can I maintain or contribute with documentation part?

Hi @aditya4567uk, this issue is very large and requires a lot of internal/operational knowledge of the project.
I am not sure this is the best issue for a new contributor. Additionally, I have already begun work on this issue but haven't gotten the time to complete it yet.

Thanks for your interest in contributing!

@joshuasing joshuasing removed this from the v0.20.0 milestone Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@joshuasing joshuasing

Labels
contributor: needs feedback Feedback is wanted before these changes are merged size: XL type: documentation This involves updating, adding or removing javadoc or other documentation type: feature This adds a new feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: add documentation ChameleonFramework/Chameleon
2 participants
@joshuasing @aditya4567uk