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

Add documentation for multi format reader #401

Merged
merged 13 commits into from
Aug 22, 2024

Conversation

lukaspie
Copy link
Collaborator

No description provided.

@lukaspie lukaspie linked an issue Aug 12, 2024 that may be closed by this pull request
@lukaspie lukaspie marked this pull request as ready for review August 13, 2024 13:43
@lukaspie lukaspie requested review from domna and rettigl August 13, 2024 13:43
Copy link
Collaborator

@domna domna left a comment

Choose a reason for hiding this comment

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

I think it's generally a good approach but I would rather work with an example and build an example reader from ground up rather than showing the original code of the multi format reader. It is not required for users to understand the original code + we try to abstract this complication away with it.

docs/reference/plugins.md Outdated Show resolved Hide resolved
docs/how-tos/build-a-plugin.md Outdated Show resolved Hide resolved
docs/how-tos/build-a-plugin.md Outdated Show resolved Hide resolved
docs/how-tos/build-a-plugin.md Outdated Show resolved Hide resolved
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.

@lukaspie some comments to an already good how-to showing people how to write their own parser

docs/how-tos/build-a-plugin.md Outdated Show resolved Hide resolved
docs/how-tos/build-a-plugin.md Show resolved Hide resolved
docs/how-tos/build-a-plugin.md Show resolved Hide resolved
docs/how-tos/build-a-plugin.md Outdated Show resolved Hide resolved
docs/how-tos/build-a-plugin.md Outdated Show resolved Hide resolved
docs/how-tos/use-multi-format-reader.md Outdated Show resolved Hide resolved
docs/how-tos/use-multi-format-reader.md Outdated Show resolved Hide resolved
docs/how-tos/use-multi-format-reader.md Outdated Show resolved Hide resolved
docs/how-tos/use-multi-format-reader.md Outdated Show resolved Hide resolved
docs/how-tos/use-multi-format-reader.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@rettigl rettigl left a comment

Choose a reason for hiding this comment

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

@lukaspie Excellent description, thanks a lot for the huge effort. I left a few suggestions for improvement, otherwise LGTM

.github/workflows/build_docs.yml Outdated Show resolved Hide resolved
docs/how-tos/build-a-plugin.md Show resolved Hide resolved
docs/how-tos/build-a-plugin.md Outdated Show resolved Hide resolved
docs/how-tos/build-a-plugin.md Outdated Show resolved Hide resolved
docs/how-tos/build-a-plugin.md Outdated Show resolved Hide resolved
docs/learn/multi-format-reader.md Outdated Show resolved Hide resolved
docs/learn/multi-format-reader.md Outdated Show resolved Hide resolved
docs/learn/multi-format-reader.md Outdated Show resolved Hide resolved
docs/learn/multi-format-reader.md Outdated Show resolved Hide resolved
docs/learn/multi-format-reader.md Outdated Show resolved Hide resolved
@lukaspie lukaspie merged commit 2084b60 into master Aug 22, 2024
13 checks passed
@lukaspie lukaspie deleted the 398-add-documentation-pages-for-multi-format-reader branch August 22, 2024 10:30
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.

Add documentation pages for multi format reader
4 participants