Skip to content

Commit

Permalink
Add meeting notes August 21
Browse files Browse the repository at this point in the history
  • Loading branch information
bittremieux committed Sep 2, 2024
1 parent fea3004 commit 6391601
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions meeting_notes/2024/20240821_telco.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# QC working group teleconference 21 August 2024

- Chris Bielow
- Wout Bittremieux
- Mathias Walzer

---

## Website updates

- Discussion on recent updates to the website, including changes to various pages like metrics, specifications, use cases, and validation processes.
- Identified some inconsistencies and incomplete updates on the website, particularly in the metrics section.

### Navigation and structure

- The current navigation menu was found to be confusing due to redundant links and overlapping content.
- Remove redundant links from the top menu and ensure that each menu item corresponds to a single, clear page.
- Rename some menu items for clarity, such as changing "Format" to "Introduction" or "Overview" under the "For Users" section.

## Categorization

- The idea to create two main categories: "For Developers" and "For Users," was discussed to differentiate between technical and non-technical content.
- "For Developers" would include technical documentation, specifications, and validation, while "For Users" would focus on use cases and software applications.
- Move less technical content, such as omics-specific information, to the "For Users" section, and keep technical documentation under "For Developers."

## Content specificity

- Consideration of the need to separate content specific to different types of omics (proteomics, metabolomics, lipidomics) to better target different communities.
- Discussion on the importance of keeping examples and use cases up to date and consistent with the current specifications.
- Ensure that the example files are automatically validated using GitHub Actions.

## Action items

Content review and update:

- Review and update the metrics page to ensure completeness and accuracy.
- Create a standalone "Use Cases" page separate from the omics content.

Navigation overhaul:

- Redesign the website navigation to reflect the new categorization, ensuring a clear distinction between developer-focused and user-focused content.
- Rename menu items as discussed (e.g., "Format" to "Introduction" or "Overview").

Technical improvements:

- Implement a semantic validation process in GitHub actions to automatically check the correctness of examples and other technical content.
- Explore possible solutions for ensuring link validity and overall content consistency on the website.

0 comments on commit 6391601

Please sign in to comment.