add intro and about

docs/about.md

@@ -0,0 +1,22 @@
+# About Us
+
+Welcome to our "About Us" page! Here, we provide information about our team and our affiliations.
+
+## Our Team
+
+We are a dedicated team of researchers and developers passionate about advancing the field of research software quality. Our team is based at the Barcelona Supercomputing Center (BSC), a leading research institution in high-performance computing and computational science.
+
+## OpenEBench
+
+We are proud to be part of the OpenEBench platform, a community-driven initiative aimed at promoting openness, transparency, and reproducibility in research. OpenEBench provides tools, resources, and guidelines to support researchers in benchmarking and evaluating their scientific software.
+
+## The Software Observatory
+
+As part of the OpenEBench platform, we are responsible for the Software Observatory, an initiative focused on monitoring and analyzing the landscape of research software. The Software Observatory aims to provide insights into the usage, impact, and evolution of research software across various domains and disciplines.
+
+## Contact Us
+
+If you have any questions, feedback, or would like to collaborate with us, please feel free to reach out to our team:
+
+- **Email:**
+- **GitHub:**

docs/index.md

@@ -0,0 +1,37 @@
+# Welcome!
+
+
+Designed to be measured in an automated way, the FAIRsoft indicators  offer an efficient means of evaluating research software FAIRness, enabling developers and stakeholders to optimize the impact and longevity of their software. 
+
+Feel free to explore the indicators in detail and learn how to apply them to your software projects at the [Indicators](./indicators/index.md) section.
+
+---
+
+Below are some useful links and resources to help you get started and learn more about what we do:
+
+🚀 **Quick Links:**
+
+- [GitHub Repository](https://github.com/yourusername/yourrepository): Explore the codebase, contribute, or star the repository to show your support!
+- [Software Observatory](https://yoursoftwareobservatorypage.com): Learn more about our project's presence in the wider software ecosystem and its impact.
+
+📄 **Additional Resources:**
+
+- [About the Project](about.md): Learn about the goals, objectives, and contributors behind our project.
+- [Contact Us](contact.md): Reach out to the project maintainers or team members with questions, feedback, or collaboration opportunities.
+
+---
+
+
+**Our Indicators Are Evolving!** 📈
+
+We are constantly improving and expanding our set of software quality indicators. Contributions from the community are highly encouraged and welcomed. If you have ideas, suggestions, or would like to contribute, please don't hesitate to get involved. Together, we can make a difference in the world of research software quality!
+
+> If you are interested in contributing, please refer to our [Contributing Guidelines](./CONTRIBUTING.md) for more information. 
+
+---
+
+**Citation:**
+
+If you use our indicators or find them useful in your research, please consider citing our publication:
+
+[Author(s). (Year). Title of the Paper. Journal Name, Volume(Issue), Page Range. DOI or URL](https://linktoyourpaper.com)

docs/indicators/index.md

@@ -0,0 +1,32 @@
+Each high-level FAIRsoft indicator is supported by several associated low-level indicators, which must be fulfilled to consider the high-level indicator achieved. By considering these low-level indicators, practitioners can work towards aligning their software with the criteria outlined by the FAIR principles, contributing to the ongoing effort to enhance the quality and FAIRness of research software. 
+
+
+The following list outlines the high-level FAIR indicators for research software. A detailed explanation of the low-level indicators that support each high-level indicator can be found in the respective sections. This explanation includes the rationale for measuring the indicator, the method of measurement, and the types of software to which it applies.
+
+## Findability indicators
+
+- **[F1. Identity Uniqueness](./findability/F1_identity_uniqueness/):** Whether the software has a proper, unique and persistent identifier. 
+- **[F2. Existence of Metadata](./findability/F2_existence_of_metadata/):** Whether the software is described with rich metadata, including scientific applicability.
+- **[F3. Discoverability](./findability/F3_searchability/):** How software can be found.
+
+
+## Accessibility indicators
+
+- **[A1. Existence of an available working version](./accessibility/A1_downloadable/):** Whether it is possible to access/download/build a working version of the software. 
+- **[A2. Software history trackability](./accessibility/A2_trackability/):** Whether code and metadata are available even when the software is no longer in use.
+- **[A3. Unrestricted access](./accessibility/A3_unrestricted_access/)**: Whether the software lacks restrictions in terms of authorization and infrastructure/platform needed to use it.
+
+
+## Interoperability indicators
+
+- **[I1. Data Format Standards and Practices](./interoperability/I1_input_output/):** Whether the software adheres to data format standards and its operational practices concerning data handling it encompasses standard formats and APIs, the flexibility and verifiability of these formats, and the tracking of data provenance. 
+- **[I2. Software Integration](./interoperability/I2_workflow_compatibility/):** Whether software can be easily integrated into workflows or used in connection with other software.
+- **[I3. Dependencies availability](./interoperability/I3_dependencies_available/)**: Whether dependencies are documented and mechanisms to obtain them exist.
+
+
+## Reusability indicators 
+
+- **[R1. Existence of usage documentation](./reusability/R1_usage_documentation/):** Whether software provides adequate usage documentation.
+- **[R2. Existence of license and/or terms of use](./reusability/R2_license/):** Whether a clear and accessible usage license is provided.
+- **[R3. Existence of Contribution Recognition and Governance](./reusability/R3_contribution_policy/):** Whether there are policies governing contributor roles and systems in place for acknowledging their contributions ensuring fair and transparent collaboration within software projects.
+- **[R4. Existence of Versioning and Historical Traceability](./reusability/R4_provenance/):** How effectively the software manages version control and documents historical changes, ensuring clear updates traceability and consistency in release practices for enhanced reliability, sustainability and auditability.

mkdocs.yml

@@ -93,26 +93,28 @@ repo_url: https://github.com/inab/FAIRsoft_indicators
 # |                                                                                                        |
 # +--------------------------------------------------------------------------------------------------------+
 nav:
-    - Overview: 
-      - The FAIRsoft indicators: introduction/index.md
-      - How to contribute: introduction/CONTRIBUTING.md
-    - Findability:
-      - F1. Identity Uniqueness: findability/F1_identity_uniqueness.md
-      - F2. Existence of metadata: findability/F2_existence_of_metadata.md 
-      - F3. Discoverability: findability/F3_searchability.md
-    - Accessiblity: 
-      - A1. Existence of an available working version: accessibility/A1_downloadable
-      - A2. Software history trackability: accessibility/A2_trackability
-      - A3. Unrestricted Access: accessibility/A3_unrestricted_access 
-    - Interoperability:
-      - I1. Data Format Standards and Practices: interoperability/I1_input_output.md
-      - I2. Software Integration: interoperability/I2_workflow_compatibility.md
-      - I3. Dependencies availability: interoperability/I3_dependencies_available.md
-    - Reusability: 
-      - R1. Existence of usage documentation: reusability/R1_usage_documentation.md
-      - R2. Existence of license and/or terms of use: reusability/R2_license.md
-      - R3. Existence of Contribution Recognition and Governance: reusability/R3_contribution_policy.md
-      - R4. Existence of Versioning and Historical Traceabilitye: reusability/R4_provenance.md
+    - Welcome: index.md
+    - Indicators:
+      - Overview : indicators/index.md
+      - Findability:
+        - F1. Identity Uniqueness: indicators/findability/F1_identity_uniqueness.md
+        - F2. Existence of metadata: indicators/findability/F2_existence_of_metadata.md 
+        - F3. Discoverability: indicators/findability/F3_searchability.md
+      - Accessiblity: 
+        - A1. Existence of an available working version: indicators/accessibility/A1_downloadable
+        - A2. Software history trackability: indicators/accessibility/A2_trackability
+        - A3. Unrestricted Access: indicators/accessibility/A3_unrestricted_access 
+      - Interoperability:
+        - I1. Data Format Standards and Practices: indicators/interoperability/I1_input_output.md
+        - I2. Software Integration: indicators/interoperability/I2_workflow_compatibility.md
+        - I3. Dependencies availability: indicators/interoperability/I3_dependencies_available.md
+      - Reusability: 
+        - R1. Existence of usage documentation: indicators/reusability/R1_usage_documentation.md
+        - R2. Existence of license and/or terms of use: indicators/reusability/R2_license.md
+        - R3. Existence of Contribution Recognition and Governance: indicators/reusability/R3_contribution_policy.md
+        - R4. Existence of Versioning and Historical Traceabilitye: indicators/reusability/R4_provenance.md
+    - How to contribute: introduction/CONTRIBUTING.md
+    - About Us: about.md
 
 
 
@@ -303,11 +305,13 @@ theme:
   #- header.autohide # Hide header when user scrolls past a specific point.
 
   # Navigation:
-    - navigation.tabs
-    - navigation.sections 
-    - navigation.expand
+    #- navigation.tabs
+    #- navigation.sections 
+    #- navigation.expand
     - navigation.path
-
+    - navigation.indexes
+
+
   # Search
   #
   #- search.highlight # Search will highlight the searched word(s) on the page.*
@@ -497,6 +501,8 @@ extra:
 markdown_extensions: 
   - tables 
   - pymdownx.superfences
+  - attr_list
+  - md_in_html
   - pymdownx.tabbed:
       alternate_style: true 
   - markdown.extensions.admonition: