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

Make it easier to contribute code and documentation #1051

Open
RoneoOrg opened this issue Sep 23, 2022 · 0 comments
Open

Make it easier to contribute code and documentation #1051

RoneoOrg opened this issue Sep 23, 2022 · 0 comments
Labels
bug Something isn't working

Comments

@RoneoOrg
Copy link

RoneoOrg commented Sep 23, 2022

Hi there,

to submit a new feature, the workflow is the following:

  • submit a first PR updating the code
  • update exampleSite requires to switch to another Git branch
  • and submit a second PR for exampleSite
  • then updating the doc requires to
  • clone another repo containing the wiki (no quick update in the browser is offered for wikis)
  • setup a new remote repo
  • submit a third separate PR

That's super complex, is there a way to make it easier?

Other themes use this structure:

  • a single repo hosts the code and exampleSite
  • this exampleSite contains the documentation, which is published along with the demo

Advantages:

  • less Git knowledge is required
  • a single PR contains every required modification, more chances are that the doc is updated on time
@RoneoOrg RoneoOrg added the bug Something isn't working label Sep 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant