Skip to content

Commit

Permalink
Merge pull request #780 from achtzig20/userguide-update
Browse files Browse the repository at this point in the history
chore: update user guide with new features
  • Loading branch information
tom-rm-meyer-ISST authored Feb 24, 2025
2 parents 8f44cf8 + 564a868 commit 0ab83e4
Show file tree
Hide file tree
Showing 45 changed files with 180 additions and 279 deletions.
279 changes: 130 additions & 149 deletions docs/user/User_Guide.md

Large diffs are not rendered by default.

Binary file modified docs/user/img/catalog_view_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/user/img/dashboard_add_buttons.png
Binary file not shown.
Binary file removed docs/user/img/dashboard_add_delivery.png
Binary file not shown.
Binary file removed docs/user/img/dashboard_add_demand.png
Binary file not shown.
Binary file removed docs/user/img/dashboard_add_production.png
Binary file not shown.
Binary file removed docs/user/img/dashboard_filters.png
Binary file not shown.
5 changes: 0 additions & 5 deletions docs/user/img/dashboard_filters.png.license

This file was deleted.

Binary file removed docs/user/img/dashboard_own_site.png
Binary file not shown.
5 changes: 0 additions & 5 deletions docs/user/img/dashboard_own_site.png.license

This file was deleted.

Binary file removed docs/user/img/dashboard_partner_site.png
Binary file not shown.
5 changes: 0 additions & 5 deletions docs/user/img/dashboard_partner_site.png.license

This file was deleted.

Binary file removed docs/user/img/dashboard_view.png
Binary file not shown.
5 changes: 0 additions & 5 deletions docs/user/img/dashboard_view.png.license

This file was deleted.

5 changes: 0 additions & 5 deletions docs/user/img/dashboard_view_list.png.license

This file was deleted.

Binary file added docs/user/img/materials_add_delivery.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/user/img/materials_add_delivery.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2025 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/puris/blob/main/docs/user/img/materials_add_delivery.png
Binary file added docs/user/img/materials_add_demand.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/user/img/materials_add_demand.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2025 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/puris/blob/main/docs/user/img/materials_add_demand.png
Binary file added docs/user/img/materials_add_production.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/user/img/materials_add_production.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2025 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/puris/blob/main/docs/user/img/materials_add_production.png
Binary file added docs/user/img/materials_add_stock.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/puris/blob/main/docs/user/img/dashboard_add_production.png
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2025 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/puris/blob/main/docs/user/img/materials_add_stock.png
Binary file added docs/user/img/materials_detail_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/user/img/materials_detail_view.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2025 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/puris/blob/main/docs/user/img/materials_detail_view.png
Binary file added docs/user/img/materials_list_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/puris/blob/main/docs/user/img/dashboard_add_delivery.png
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2025 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/puris/blob/main/docs/user/img/materials_list_view.png
Binary file removed docs/user/img/negotiation_view_list.png
Binary file not shown.
Binary file modified docs/user/img/negotiations_view_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user/img/notification_detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/user/img/notification_detail.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2025 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/puris/blob/main/docs/user/img/notification_detail.png
Binary file modified docs/user/img/notification_send.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/puris/blob/main/docs/user/img/dashboard_add_demand.png
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2025 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/puris/blob/main/docs/user/img/notification_send.png
Binary file modified docs/user/img/notification_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/puris/blob/main/docs/user/img/dashboard_add_buttons.png
This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).
- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2025 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/puris/blob/main/docs/user/img/notification_view.png
Binary file removed docs/user/img/stock_view.png
Binary file not shown.
5 changes: 0 additions & 5 deletions docs/user/img/stock_view.png.license

This file was deleted.

Binary file removed docs/user/img/stock_view_added_material_stock.png
Binary file not shown.
5 changes: 0 additions & 5 deletions docs/user/img/stock_view_added_material_stock.png.license

This file was deleted.

Binary file not shown.
5 changes: 0 additions & 5 deletions docs/user/img/stock_view_selected_material_stock.png.license

This file was deleted.

Binary file modified docs/user/img/transfers_view_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,7 @@ export const DemandCategoryModal = ({ open, mode, onClose, onSave, demand, deman
{mode === 'create' && (
<Button
variant="contained"
color="primary"
sx={{ display: 'flex', gap: '.25rem' }}
onClick={() => handleSaveClick(temporaryDemand)}
>
Expand Down
72 changes: 3 additions & 69 deletions frontend/src/index.css
Original file line number Diff line number Diff line change
Expand Up @@ -240,74 +240,8 @@ textarea:focus {
font-family: 'Inter', sans-serif;
}

.markdown h1 {
@apply text-2xl font-bold my-3;
}

.markdown h2 {
@apply text-xl font-bold my-2;
}

.markdown h3 {
@apply text-lg font-bold my-2;
}

.markdown h4 {
@apply text-base font-bold my-2;
}

.markdown h5 {
@apply text-base font-bold my-2;
}

.markdown h6 {
@apply text-base font-bold my-2;
}

.markdown p {
@apply text-base py-3;
}

.markdown a {
@apply text-blue-500;
}

.markdown ul {
@apply list-disc ps-5;
}

.markdown ol {
@apply list-decimal ps-5;
}

.markdown li {
@apply text-base;
}

.markdown blockquote {
@apply border-l-4 border-gray-300 pl-4;
}

.markdown pre {
@apply bg-gray-100 p-4 rounded;
}

.markdown code {
@apply bg-gray-100 p-1 rounded;
}

.markdown table {
@apply w-full;
}

.markdown table th {
@apply bg-gray-200 p-2;
}

.markdown table td {
@apply p-2;
}

.markdown img {
@apply mx-auto;
max-width: 100%;
margin-bottom: 1rem;
box-shadow: 1px 1px 3px 0 rgba(0, 0, 0, 0.1);
}
2 changes: 1 addition & 1 deletion frontend/src/views/UserGuideView.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export const UserGuideView = () => {
});
}, []);
return (
<Box marginInline="auto" maxWidth="48rem">
<Box marginInline="auto" maxWidth="60rem">
<Markdown className="markdown">{markdown}</Markdown>
</Box>
);
Expand Down

0 comments on commit 0ab83e4

Please sign in to comment.