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

Improve documentation #362

Merged
merged 1 commit into from Jul 18, 2022
Merged

Improve documentation #362

merged 1 commit into from Jul 18, 2022

Conversation

JoeyStk
Copy link
Contributor

@JoeyStk JoeyStk commented Jun 28, 2022

Short description

This PR improves the documentation as we have it so far

Proposed changes

This PR adds documentation about

  • dev-tools as they exist in the project so far
  • concepts like internationalization, documentation and CI
  • instructions on how to contribute on the project

Resolved issues

Fixes: #277

@JoeyStk JoeyStk requested a review from a team as a code owner June 28, 2022 09:43
@JoeyStk JoeyStk force-pushed the enhancement/documentation branch 2 times, most recently from ec4a0c2 to 3e1ac86 Compare June 28, 2022 11:35
Copy link
Member

@timobrembeck timobrembeck left a comment

Choose a reason for hiding this comment

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

Thanks! 👍
In general it looks good, just a few adjustments missing for this repository.

docs/src/continous-integration.rst Show resolved Hide resolved
docs/src/dev-tools.rst Outdated Show resolved Hide resolved
docs/src/dev-tools.rst Outdated Show resolved Hide resolved
docs/src/documentation.rst Outdated Show resolved Hide resolved
docs/src/documentation.rst Outdated Show resolved Hide resolved
docs/src/documentation.rst Outdated Show resolved Hide resolved
docs/src/documentation.rst Outdated Show resolved Hide resolved
docs/src/dev-tools.rst Outdated Show resolved Hide resolved
docs/src/internationalization.rst Outdated Show resolved Hide resolved
docs/src/documentation.rst Outdated Show resolved Hide resolved
@JoeyStk JoeyStk force-pushed the enhancement/documentation branch 2 times, most recently from 5d56ddd to e51f6e4 Compare July 4, 2022 08:48
Copy link
Member

@timobrembeck timobrembeck left a comment

Choose a reason for hiding this comment

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

Thanks! 👍
Just a few details of the CircleCI documentation are missing I think.

docs/src/continous-integration.rst Outdated Show resolved Hide resolved
docs/src/continous-integration.rst Show resolved Hide resolved
docs/src/continous-integration.rst Outdated Show resolved Hide resolved
docs/src/continous-integration.rst Outdated Show resolved Hide resolved
docs/src/continous-integration.rst Outdated Show resolved Hide resolved
docs/src/continous-integration.rst Outdated Show resolved Hide resolved
docs/src/continous-integration.rst Outdated Show resolved Hide resolved
@JoeyStk JoeyStk force-pushed the enhancement/documentation branch 3 times, most recently from fc7f797 to 45ce1f2 Compare July 18, 2022 13:14
Co-authored-by: Timo Ludwig <ludwig@integreat-app.de>
Copy link
Member

@timobrembeck timobrembeck left a comment

Choose a reason for hiding this comment

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

Thanks a lot! 👍
I fixed some final things, but now this is ready to merge 🎉

@timobrembeck timobrembeck merged commit 520dac4 into develop Jul 18, 2022
@timobrembeck timobrembeck deleted the enhancement/documentation branch July 18, 2022 16:25
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.

Improve documentation
2 participants