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: Rendering Breadcrumbs #649

Merged
merged 2 commits into from
Nov 29, 2023
Merged

Conversation

manuelroemer
Copy link
Member

New Pull Request

For more information, see the CONTRIBUTING guide.

Prerequisites

Please make sure you can check the following boxes:

  • I have read the CONTRIBUTING document
  • My code follows the code style of this project
  • All new and existing tests passed

Type(s) of Changes

Contribution Type

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue, please reference the issue id)
  • New feature (non-breaking change which adds functionality, make sure to open an associated issue first)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • I have updated the documentation accordingly
  • I have added tests to cover my changes

Description

Documents how breadcrumbs can be rendered from an app shell and from pilets, respectively. I think this is not yet described anywhere. The only location where I found some details about how to render breadcrumbs, from pilets specifically, were in this chat message.

Remarks

None.

@manuelroemer manuelroemer added the documentation Concerns the available documentation. label Nov 29, 2023
Copy link
Contributor

@FlorianRappl FlorianRappl left a comment

Choose a reason for hiding this comment

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

LGTM - only improvement is to make this a bit more generic.

src/plugins/piral-breadcrumbs/README.md Outdated Show resolved Hide resolved
src/plugins/piral-breadcrumbs/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@FlorianRappl FlorianRappl left a comment

Choose a reason for hiding this comment

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

Great one - thanks!

@FlorianRappl FlorianRappl merged commit 485fa75 into documentation Nov 29, 2023
3 checks passed
@FlorianRappl FlorianRappl deleted the doc/using-breadcrumbs branch November 29, 2023 15:57
@FlorianRappl FlorianRappl added this to the 1.4.0 milestone Nov 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Concerns the available documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants