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

doc: add steps to add new plugin in CONTRIBUTING.md #138

Merged
merged 1 commit into from
Oct 1, 2023

Conversation

horriblename
Copy link
Collaborator

Took me a while to figure this out

Should we rewrite/regenerate the table of contents in CONTRIBUTING.md to include the "keybinds" and "adding plugins" subsections as well?

@NotAShelf
Copy link
Owner

NotAShelf commented Sep 23, 2023

I am not exactly sure if we should include keybind and plugin addition instructions in CONTRIBUTING.md - I was thinking of reserving a page for development guides on the documentation site and keep CONTRIBUTING.md strictly for guidelines for style, commits and so on.

The downside of the static documentation is that it's asciidoc over markdown, which is slightly harder to contribute to; but offers more possibilities for organization and styling.

@horriblename
Copy link
Collaborator Author

I'd rather use markdown as well but I think putting it on the doc site makes more sense - and probably easier to find as a reader

@NotAShelf
Copy link
Owner

I'll move the keybinds guide to the documentation. We can refactor this PR to move the new plugin guide to it as well.

@NotAShelf
Copy link
Owner

I'll move the keybinds guide to the documentation. We can refactor this PR to move the new plugin guide to it as well.

this will take a little longer than expected as I'm also refactoring the documentation in the process, should be done in a day or two

@horriblename horriblename changed the base branch from main to docs-refactor October 1, 2023 11:27
@horriblename
Copy link
Collaborator Author

@NotAShelf refactor done

Copy link
Owner

@NotAShelf NotAShelf left a comment

Choose a reason for hiding this comment

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

The section indicator is missing, but no trouble. I'll add it.

LGTM

@NotAShelf NotAShelf merged commit 2a249f4 into NotAShelf:docs-refactor Oct 1, 2023
6 checks passed
@horriblename horriblename deleted the patch-1 branch June 27, 2024 08:04
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.

2 participants