Skip to content

Commit

Permalink
Update PMUI-Readme-rendering.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jgonz120 authored Dec 20, 2024
1 parent 1b65d7d commit 9f841b3
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion accepted/2024/PMUI-Readme-rendering.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,37 @@ The selected tab will not change even when the newly selected package does not h

If there is an error rendering the README then a message will be displayed for the users.


```mermaid
---
title: README tab visible?
---
flowchart TD
A(Which PM UI Tab Selected?)
A --> |Browse|B(Source supports downloading README?)
B --> |Yes|C(README tab visible)
B --> |No|D(README tab hidden)
A --> |Install/Update/Consolidate|E(Source supports downloading README?)
E --> |Yes|C
E --> |No|F(Selected package version is in GPF?)
F --> |Yes|C
F --> |No|D
```
```mermaid
---
title: README tab contents?
---
flowchart TD
A(README tab visible)
A --> |Yes|D(Remote README available?)
D --> |Yes|E(Source returned README?)
E --> |Yes|F(README)
E --> |No|G(No README message)
D --> |No|H(Embedded README found)
H --> |Yes|F
H --> |No|G
```

#### Package Details
This tab is always rendered and contains the package details information along with the Vulnerabilty and Depreciation information.

Expand Down Expand Up @@ -198,4 +229,4 @@ Implement the option for users to opt out of rendering all images from README, s

Update `INuGetPackageFileService` to allow for authenticated feeds.

Add caching to avoid downloading the README multiple times for the same URL.
Add caching to avoid downloading the README multiple times for the same URL.

0 comments on commit 9f841b3

Please sign in to comment.