Skip to content

Update code documentation and plugin Wiki #50

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
Open
4 tasks
Tracked by #24
dasupradyumna opened this issue Apr 20, 2025 · 0 comments
Open
4 tasks
Tracked by #24

Update code documentation and plugin Wiki #50

dasupradyumna opened this issue Apr 20, 2025 · 0 comments
Assignees
@dasupradyumna
Labels
internal Related to internal project development
Milestone
v1.0.0

Comments

@dasupradyumna
Copy link
Owner

dasupradyumna commented Apr 20, 2025 •
edited
Loading

Summary

Provide documentation for all the source code in the plugin - both Rust and VimL. This will help to easily browse the code using Rust documentation feature as well as make it easier to contribute.

  • Add README for project documenting the current features
  • Add CONTRIBUTING with simple guidelines
  • Create a demo video for showcasing the usage of the plugin in the Wiki
  • Add CHANGELOG for tracking changes from v1.0.0 onward
@dasupradyumna dasupradyumna mentioned this issue Apr 20, 2025
Open
3 tasks
@dasupradyumna dasupradyumna self-assigned this Apr 20, 2025
@dasupradyumna dasupradyumna added the internal Related to internal project development label Apr 20, 2025
@dasupradyumna dasupradyumna added this to the v1.0.0 milestone Apr 20, 2025
@dasupradyumna dasupradyumna changed the title Add documentation for all items in the plugin source code Update code documentation and plugin Wiki Apr 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dasupradyumna dasupradyumna

Labels
internal Related to internal project development
Projects
None yet
Milestone
v1.0.0
Development

No branches or pull requests
1 participant
@dasupradyumna