Skip to content

Make getting-started document page language simpler and clearer. - #249

Merged
Ostrzyciel merged 5 commits into
mainfrom
jan/patch-docs
Jul 29, 2025
Merged

Make getting-started document page language simpler and clearer.#249
Ostrzyciel merged 5 commits into
mainfrom
jan/patch-docs

Conversation

@Ja-Gk-00

@Ja-Gk-00 Ja-Gk-00 commented Jul 29, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Modify the getting-started page in the docs to simplify it, make it more concise and clearer for the user.

@codecov

codecov Bot commented Jul 29, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Ostrzyciel
Ostrzyciel requested changes Jul 29, 2025
View reviewed changes

@Ostrzyciel Ostrzyciel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Reviewed the rdflib part – please apply same changes to the rest :)

Also, please fix the PR name. Explain clearly what this does (in Present Simple), not the process which this PR is a part of. And watch out for typos ;)

Strongly suggest splitting this PR into multiple, otherwise I don't believe in this being merged quickly.

Comment thread docs/getting-started.md Outdated
Comment thread docs/getting-started.md Outdated
Comment thread docs/getting-started.md Outdated
Comment thread docs/getting-started.md Outdated
Comment thread docs/getting-started.md Outdated
Comment thread docs/getting-started.md Outdated
Comment thread docs/getting-started.md Outdated
@Ja-Gk-00 Ja-Gk-00 changed the title Iterative documentation developement - patch Make documentation language simple and clearer. Jul 29, 2025
@Ja-Gk-00 Ja-Gk-00 changed the title Make documentation language simple and clearer. Make getting-started document page language simpler and clearer. Jul 29, 2025
@Ja-Gk-00

Ja-Gk-00 commented Jul 29, 2025

Copy link
Copy Markdown
Contributor Author

Reviewed the rdflib part – please apply same changes to the rest :)

Also, please fix the PR name. Explain clearly what this does (in Present Simple), not the process which this PR is a part of. And watch out for typos ;)

Strongly suggest splitting this PR into multiple, otherwise I don't believe in this being merged quickly.

Ok, updated so the PR just focuses on modifying getting-started docs page, I will do similarly for the other pages and issue a PR for each.

Ostrzyciel
Ostrzyciel approved these changes Jul 29, 2025
View reviewed changes

@Ostrzyciel Ostrzyciel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good!

@Ostrzyciel
Ostrzyciel enabled auto-merge (squash) July 29, 2025 10:32
@Ostrzyciel
Ostrzyciel merged commit 5008cf9 into main Jul 29, 2025
11 checks passed
@Ostrzyciel
Ostrzyciel deleted the jan/patch-docs branch July 29, 2025 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Ostrzyciel Ostrzyciel Ostrzyciel approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Ja-Gk-00 @Ostrzyciel