Isolating icon table from readme (#301)

Co-authored-by: github-actions <github-actions[bot]@users.noreply.github.com>

.github/md-generator/generate_markdown.py

@@ -241,22 +241,22 @@ def main(root_folder):
     icon_data = process_icon_sets(folders, all_concepts)
     bars = generate_bar_representation(icon_data, all_concepts)
 
-    markdown_content = ""
+    readme_content = ""
 
     # Add documentation
     documentation = "![Mistica Icons](.github/resources/mistica-icons-light.svg#gh-light-mode-only)" + BREAK + "![Mistica Icons](.github/resources/mistica-icons-dark.svg#gh-dark-mode-only)" + BREAK + BREAK + "Mística Icons is a multibrand icon system that contains all icons that is working in [Mistica Design System](https://github.com/Telefonica/mistica) now.  " + BREAK + BREAK + "Mistica support [Brand Factory icons](https://brandfactory.telefonica.com/document/1086#/nuestra-identidad/iconos). This set of icons are a big list of different icons and style that Brand Team worked to be used through Telefonica applications." + BREAK + BREAK + "If you have any question, please you can ask directly in the app of Microsoft Teams, in [Mistica Team](https://teams.microsoft.com/l/team/19%3ad2e3607a32ec411b8bf492f43cd0fe0c%40thread.tacv2/conversations?groupId=e265fe99-929f-45d1-8154-699649674a40&tenantId=9744600e-3e04-492e-baa1-25ec245c6f10).  " + \
         BREAK + BREAK + "## Documentation" + BREAK + BREAK + "### Develop" + BREAK + BREAK + "#### iOS and Android" + BREAK + BREAK + "You can get .pdf or .svg files from this repo." + BREAK + BREAK + "#### Web" + BREAK + BREAK + \
         "Visit [Mistica Storybook](https://mistica-web.vercel.app/?path=/story/icons-catalog--catalog) to get all the detail about using Mistica Icons Library" + BREAK + BREAK + "### Design" + BREAK + BREAK + "Use Mística icons library in Figma!" + BREAK + BREAK
-    markdown_content += documentation + BREAK
+    readme_content += documentation + BREAK
 
-    markdown_content += "## Equivalence status\n\n"
+    readme_content += "## Equivalence status\n\n"
     for bar in bars:
-        markdown_content += bar + "\n"
-    markdown_content += "  " + BREAK
+        readme_content += bar + "\n"
+    readme_content += "  " + BREAK
 
     # Add equivalence status table
     markdown_table = generate_markdown_table(icon_data, folders)
-    markdown_content += markdown_table + "\n"
+    readme_content += markdown_table + "\n"
 
     legend = (
             "<sub>**Concepts**: Counts the different names of icons in the set excluding any variations in style or weight.</sub>  " 
@@ -272,14 +272,25 @@ def main(root_folder):
             "<sub>**Missing**: Missing icons with respect to other sets.</sub>"
             )
 
-    markdown_content += legend + "\n"
-
-    markdown_content += "## Icon equivalence\n\n"
+    icon_table_readme = (
+                        "## Icon table equivalence\n\n"
+                        + "This table shows the equivalence of icons between the different brands.\n\n"
+                        + "[View icon table →](ICON_TABLE.md)\n\n"
+                        + "[![Icon Table Preview](.github/resources/icon_table.png)](ICON_TABLE.md)"
+                        )
+    readme_content += legend + "\n\n" + icon_table_readme + "\n\n"
+
+
+    icon_table_content = ""
+    icon_table_content += "# Icon table equivalence\n\n"
     icon_table_output = generate_icon_table(root_folder)
-    markdown_content += icon_table_output + "\n"
+    icon_table_content += icon_table_output + "\n"
 
     with open("./README.md", "w") as file:
-        file.write(markdown_content)
+        file.write(readme_content)
+
+    with open("./ICON_TABLE.md", "w") as file:
+        file.write(icon_table_content)
 
 if __name__ == "__main__":
     root_folder = "icons"

.github/workflows/figma-export.yml

@@ -126,7 +126,7 @@ jobs:
           pr_title: "Update Figma icons"
           pr_body: "
             New version of icons exported from [Mistica Icons](${{env.MISTICA_ICONS_FILE_URL}}), [O2](${{env.O2_FILE_URL}}), [O2-new](${{env.O2_NEW_FILE_URL}}), [Blau](${{env.BLAU_FILE_URL}}) & [Vivo](${{env.VIVO_FILE_URL}}) \n
-            - [ ] [Review readme import-figma-icons](https://github.com/Telefonica/mistica-icons/tree/import-figma-icons)"
+            - [ ] [Review icon table in import-figma-icons](https://github.com/Telefonica/mistica-icons/tree/import-figma-icons)"
           pr_draft: ${{ github.event.inputs.draft }}
           github_token: ${{ secrets.NOVUM_PRIVATE_REPOS }}
 
@@ -197,7 +197,7 @@ jobs:
           pr_title: "Update Mística icons"
           pr_body: "
             New version of icons exported from [Mistica Icons](${{env.MISTICA_ICONS_FILE_URL}}) \n
-            - [ ] [Review readme import-figma-icons](https://github.com/Telefonica/mistica-icons/tree/import-figma-icons)"
+            - [ ] [Review icon table in import-figma-icons](https://github.com/Telefonica/mistica-icons/tree/import-figma-icons)"
           pr_draft: ${{ github.event.inputs.draft }}
           github_token: ${{ secrets.NOVUM_PRIVATE_REPOS }}
 
@@ -268,7 +268,7 @@ jobs:
           pr_title: "Update O2 icons"
           pr_body: "
             New version of icons exported from [O2](${{env.O2_FILE_URL}}) \n
-            - [ ] [Review readme import-figma-icons](https://github.com/Telefonica/mistica-icons/tree/import-figma-icons)"
+            - [ ] [Review icon table in import-figma-icons](https://github.com/Telefonica/mistica-icons/tree/import-figma-icons)"
           pr_draft: ${{ github.event.inputs.draft }}
           github_token: ${{ secrets.NOVUM_PRIVATE_REPOS }}
 
@@ -339,7 +339,7 @@ jobs:
           pr_title: "Update O2-new icons"
           pr_body: "
             New version of icons exported from [O2-new](${{env.O2_FILE_URL}}) \n
-            - [ ] [Review readme import-figma-icons](https://github.com/Telefonica/mistica-icons/tree/import-figma-icons)"
+            - [ ] [Review icon table in import-figma-icons](https://github.com/Telefonica/mistica-icons/tree/import-figma-icons)"
           pr_draft: ${{ github.event.inputs.draft }}
           github_token: ${{ secrets.NOVUM_PRIVATE_REPOS }}
 
@@ -408,7 +408,7 @@ jobs:
           pr_title: "Update Blau icons"
           pr_body: "
             New version of icons exported from [Blau](${{env.BLAU_FILE_URL}}) \n
-            - [ ] [Review readme import-figma-icons](https://github.com/Telefonica/mistica-icons/tree/import-figma-icons)"
+            - [ ] [Review icon table in import-figma-icons](https://github.com/Telefonica/mistica-icons/tree/import-figma-icons)"
           pr_draft: ${{ github.event.inputs.draft }}
           github_token: ${{ secrets.NOVUM_PRIVATE_REPOS }}
 
@@ -479,12 +479,12 @@ jobs:
           pr_title: "Update Vivo icons"
           pr_body: "
             New version of icons exported from [Vivo](${{env.VIVO_FILE_URL}}) \n
-            - [ ] [Review readme import-figma-icons](https://github.com/Telefonica/mistica-icons/tree/import-figma-icons)"
+            - [ ] [Review icon table in import-figma-icons](https://github.com/Telefonica/mistica-icons/tree/import-figma-icons)"
           pr_draft: ${{ github.event.inputs.draft }}
           github_token: ${{ secrets.NOVUM_PRIVATE_REPOS }}
 # pr_body: "
 #             New version of icons exported from [Mistica Icons][mistica-icons] & [O2][o2-icons] n\
-#             - [ ] [Review readme import-figma-icons][readme] n\
+#             - [ ] [Review icon table in import-figma-icons][readme] n\
 
 #             [mistica-icons]: https://www.figma.com/file/${{env.TELEFONICA_FIGMA_ID}}/Mistica'-Icons?node-id=0%3A71 n\
 #             [o2-icons]: https://www.figma.com/file/${{env.O2_FIGMA_ID}}/?node-id=611%3A3298 n\