Skip to content

Commit e2b8405

Browse files
Xiuqi LiXiuqi Li
authored andcommitted
updated ReadMe
1 parent f5b8e8a commit e2b8405

4 files changed

Lines changed: 63 additions & 3 deletions

File tree

.DS_Store

0 Bytes
Binary file not shown.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@
77
/_site/
88

99
**/*.quarto_ipynb
10+
README_files/

README.md

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,61 @@
1-
# Open-Science-Inventory
2-
Quarto website for the UCSB Library Open Science Inventory Project
1+
# UCSB Library Open Science Inventory
2+
3+
This repository contains the source for the **UCSB Library Open Science Inventory Project** and the output Quarto website that showcases open science-related services, instruction, and community activities across the UCSB Library.
4+
5+
6+
## What the Website Covers
7+
8+
This repository is used to publish the [project website](https://ucsb-library-research-data-services.github.io/Open-Science-Inventory/) via GitHub Pages. The website contains 4 main pages:
9+
10+
- **Home** providing an overview to the project and dispalying the interactive diagram
11+
- **Services & Programs** providing brief description to services & programs
12+
- **Instruction & Consultation** providing brief description to instruction & consultation topics
13+
- **Engagement & Community** providing brief description to engagement & community effrots
14+
15+
A central feature of the site is an **interactive chord diagram** that highlights connections among offerings, providers, and open science domains.
16+
17+
18+
## Repository Structure
19+
20+
```text
21+
.
22+
├── _quarto.yml # Quarto website configuration
23+
├── index.qmd # Home page
24+
├── services.qmd # Services & Programs section
25+
├── instruction.qmd # Instruction & Consultation section
26+
├── engagement.qmd # Engagement & Community section
27+
├── styles.css # Custom site styling
28+
├── code/
29+
│ └── 001-data-viz.R # Script to generate chord diagram
30+
├── data_raw/
31+
│ └── OS-Inventory-list-20260202.xlsx # Source inventory spreadsheet
32+
├── data_processed/
33+
│ └── label_angles.csv # Metadata for interactive image switching
34+
├── images/
35+
│ ├── chord-diagram.gif # Animated diagram preview
36+
│ ├── image-preload-links.txt # Preload tags for static images
37+
│ └── static/ # JPEG/PNG exports
38+
├── .github/
39+
│ └── workflows/main.yml # GitHub Actions for Quarto publishing
40+
└── Open-Science_Inventory.Rproj # RStudio project file
41+
```
42+
43+
44+
## Notes for Maintainers
45+
46+
* Update the Excel inventory in `data_raw/` when the underlying inventory changes
47+
* Regenerate the chord diagram visualization if inventory structure, labels, or relationships change
48+
* Recompute and write label-angle metadata to `data_processed/label_angles.csv`
49+
* Edit page content in the .qmd source files to reflect the updates
50+
51+
52+
## Disclosure
53+
54+
The first version of this ReadMe file was drafted by Codex. The contributors have reviewed the file, make corrections, and expanded on details.
55+
56+
Additionally, LLMs (e.g., ChatGPT, Google Gemini) were used to troubleshoot code during the development process.
57+
58+
59+
60+
61+

index.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ The project team would like to thank colleagues who provided valuable feedback a
122122
## Citation and Contact
123123

124124
:::{.callout-tip}
125-
## Please cit this work as
125+
## Please cite this work as
126126

127127
Li X, Agrawal A, Budden A, Brun J, Erickson S, Jablonski J, Janée J, LaBonte K (2026). UCSB Library Open Science Services & Support Project.
128128
:::

0 commit comments

Comments
 (0)