From f1f3c7b6d84546b6f41b3b3c5443e5b4aab0170b Mon Sep 17 00:00:00 2001
From: Gorka Fraga Gonzalez <gorka.fragagonzalez@uzh.ch>
Date: Wed, 8 May 2024 11:19:06 +0200
Subject: [PATCH] Update README.md

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/README.md b/README.md
index aca43f3..13ae6af 100644
--- a/README.md
+++ b/README.md
@@ -11,3 +11,48 @@ Project entry in SNF data base: https://data.snf.ch/grants/grant/213535
 ## Instructions for content editors 
 
 Access and edit the content in the folder 'webpage_contents' 
+
+
+
+### Repository organization 
+The main files and folders are the following: 
+
+``` 
+fdcns/                            # Repository
+│
+├── .gitlab-ci.yml                # (fixed name) Has the script that will render the site with any change in the repo. 
+│
+├── webpage_contents/             #  All editable content and website settings, lay-out etc
+│   ├── _quarto.yml               # Settings defining navigation bar titles among other layout features
+│   ├── index.qmd                 # Main landing page 
+│   ├── webpage_contents.Rproj    # Recommended file for working with R locally
+│   │
+│   ├── assets/                   # contains logos, images and style used for the main site 
+│   │   ├──  styles.css           # css or scss files for additional styling
+│   │   └──  logos/               # folder with logs, additional subfolders can be: assets/images 
+│   │
+│   └── contents/                 # >> Each page will be a self-contain folder e.g.academy, nodes, organization, etc       
+│       ├──  academy/             # Example folder 
+│       │    ├── images/          # Any image or icon related to this page
+│       │    └── index.qmd        # The actual content
+│       │
+│       ├──  Working Packages/    
+│       │      └── OpenResearchData/    #An example of a blog page. Each entry is 'self contained'
+│       │               ├── index.qmd   # Landing page with list of all blog entries in the folder (Quarto 'Listing')
+│       │               │
+│       │               └── posts/
+│       │                     ├── 2024-01-18-entryTitle/ 
+│       │                     │     ├── .jpg,.png,.csv, etc   #resources for this entry, either in a folder or as files 
+│       │                     │     └── index.qmd
+│       │                    ... 
+│       └──  ...  
+│ 
+├+ ── _site    # If rendered locally this folder is created with the html files. It will be .gitignore when pushing changes to remote 
+│
+└──public                  # .gitlab-ci.yml renders the site and copis into 'public'. Folder name required by Gitlab Pages
+   │                       # [CI alert!] the content of 'public' can be seen in Gitlab Build/Artifact, not in the main repo view
+   │                       # [NOTE: although named 'public' it can be set in a private repository and thus protected]
+   └── .nojekyll           # (empty) file required by Gitlab pages if not using jekyll                      
+``` 
+
+
-- 
GitLab