Merge branch 'dev'

pepkit · Aug 14, 2024 · daf1410 · daf1410
2 parents 4046257 + 5e30b4f
commit daf1410
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 7 deletions.
diff --git a/docs/pephub/img/add-pop.png b/docs/pephub/img/add-pop.png
diff --git a/docs/pephub/img/menu-view-as-pop.png b/docs/pephub/img/menu-view-as-pop.png
diff --git a/docs/pephub/img/pop-toggle.png b/docs/pephub/img/pop-toggle.png
diff --git a/docs/pephub/user/pops.md b/docs/pephub/user/pops.md
@@ -1,17 +1,32 @@
 
-# PEPs vs POPs
+# How to organize groups of PEPs
 
-**Portable Encapsulated Projects (PEPs)** vs **PEP of PEPs (POPs).**
+### How can I organize PEPs into groups?
 
-### POPs
+We call a group of PEPs a POP -- it stands for PEP of PEPs. Since a PEP is fundamentally a table, and we make a table where each row is a link to another table.
+So, that's a table of tables -- or a PEP of PEPs, which we call a POP for short.
 
-POP is simply a group of PEPs represented as a PEP. Users can think of it as a group, collection, or folder of projects. 
+A POP is simply a group of PEPs represented as a PEP. Users can think of it as a group, collection, or folder of projects. 
 It groups PEPs together to represent similar projects, analyses, or related information, making it easier to manage and navigate related proposals.
 
 Each POP can contain other PEPs or POPs (since a POP is a PEP), allowing for a recursive structure. 
 This recursive nature enables complex hierarchies and relationships to be efficiently organized within the PEP framework.
 
-### Database structure
-In the database POP in represented as a PEP with a special schema, that containing the list of PEPs that are part of the POP.
+### How to use POPs
 
-![POPs](../img/pop.svg)
+A POP is actually just a PEP, that has a special flag set. You can create a new POP in the typical *Add PEP* interface; just select the *POP* tab.
+
+![alt text](../../img/add-pop.png)
+
+If you already have a PEP and you want to designate it as a POP, just make sure it has at least these 3 columns: `namespace`, `name`, and `tag`, which correspond to the registry path for the PEP. You can add whatever other columns you want. Then, just toggle the POP toggle button in the settings interface for the PEP:
+
+![alt text](./../img/pop-toggle.png)
+
+
+### Views
+
+There are two ways to view a POP. First, since a POP *is* a PEP, you can just use the regular table view, the same as you would any PEP. 
+Second, you can use a special "POP" view, which just shows you a linked list of the PEPs contained in the pop.
+Toggle between the two views using the *More* context menu, which provides a *View as POP* or *View as PEP* options for any PEP that has the POP toggle checked.
+
+![alt text](../../img/menu-view-as-pop.png)