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

Move all READMEs to docs, overhaul doc structure #412

Merged
merged 6 commits into from
Aug 30, 2024
Merged

Move all READMEs to docs, overhaul doc structure #412

merged 6 commits into from
Aug 30, 2024

Conversation

lukaspie
Copy link
Collaborator

No description provided.

@lukaspie lukaspie linked an issue Aug 26, 2024 that may be closed by this pull request
Move README content to documentation #405
Closed
mkuehbach
mkuehbach reviewed Aug 27, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@lukaspie lukaspie mentioned this pull request Aug 27, 2024
Merged
2 tasks
mkuehbach
mkuehbach requested changes Aug 27, 2024
View reviewed changes
Copy link
Collaborator

@mkuehbach mkuehbach left a comment

Choose a reason for hiding this comment

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

Good initiative @lukaspie as this is front-page of our activities, we need to clean also language which most of my comments address.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/reference/built-in-readers.md Outdated Show resolved Hide resolved
docs/reference/built-in-readers.md Show resolved Hide resolved
docs/reference/built-in-readers.md Show resolved Hide resolved
docs/reference/built-in-readers.md Show resolved Hide resolved
docs/reference/built-in-readers.md Outdated Show resolved Hide resolved
@lukaspie lukaspie force-pushed the 405-move-readme-content-to-documentation branch from 6ffe4e6 to b1f8fdc Compare August 27, 2024 15:08
mkuehbach
mkuehbach approved these changes Aug 30, 2024
View reviewed changes
Copy link
Collaborator

@mkuehbach mkuehbach left a comment

Choose a reason for hiding this comment

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

Good revision, approved already but solve the three remaining issues left you a suggestion how I would solve these.

docs/index.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
.github/workflows/build_docs.yml Outdated Show resolved Hide resolved
docs/tutorial/troubleshooting.md Outdated Show resolved Hide resolved
@lukaspie lukaspie merged commit 23927ac into master Aug 30, 2024
12 checks passed
@lukaspie lukaspie deleted the 405-move-readme-content-to-documentation branch August 30, 2024 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mkuehbach mkuehbach mkuehbach approved these changes

@sherjeelshabih sherjeelshabih Awaiting requested review from sherjeelshabih

@sanbrock sanbrock Awaiting requested review from sanbrock

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Move README content to documentation
2 participants
@lukaspie @mkuehbach