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

docs: clarify requirements documentation #1574

Merged
merged 3 commits into from
Jan 12, 2024

Conversation

shauke
Copy link
Collaborator

@shauke shauke commented Jan 11, 2024

PR Type

[x] Documentation content changes

Clarified the ICM required version information since there were still misunderstandings.

[x] No

Other Information

AB#92712

@shauke shauke added this to the 5.1 milestone Jan 11, 2024
@shauke shauke self-assigned this Jan 11, 2024
@marschmidt89
Copy link
Contributor

I'll take over @intershop/c3po-documentation-l10n

@shauke shauke requested a review from a team January 11, 2024 13:08
@mglatter mglatter requested review from marschmidt89 and mglatter and removed request for a team January 11, 2024 13:08
@mglatter mglatter requested a review from a team January 11, 2024 13:11
@marschmidt89
Copy link
Contributor

@shauke I reviewed it and I think it's understandable. However, I suggest not writing everything in bold, but putting it in a node section. While testing that, I realized that there seems to be a problem with the note boxes used in the PWA; they aren't rendered anymore. Is that a known issue?

marschmidt89
marschmidt89 previously approved these changes Jan 11, 2024
@shauke shauke force-pushed the docs/improve_requirements_documentation branch from 64fe5d8 to 7e2fbb2 Compare January 12, 2024 08:10
@shauke shauke marked this pull request as ready for review January 12, 2024 08:16
@shauke
Copy link
Collaborator Author

shauke commented Jan 12, 2024

Added Note box formatting and used the same extended information in the release notes.
https://github.com/intershop/intershop-pwa/releases

@shauke shauke added the documentation Improvements or additions to documentation label Jan 12, 2024
@shauke shauke merged commit afab8cf into develop Jan 12, 2024
2 checks passed
@shauke shauke deleted the docs/improve_requirements_documentation branch January 12, 2024 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants