Skip to content

Add README describing site architecture#9

Merged
alt-thompson merged 7 commits intomainfrom
first-readme-update
Nov 19, 2025
Merged

Add README describing site architecture#9
alt-thompson merged 7 commits intomainfrom
first-readme-update

Conversation

@alt-thompson
Copy link
Collaborator

@alt-thompson alt-thompson commented Oct 21, 2025

Addresses #4.

@alt-thompson alt-thompson marked this pull request as draft October 21, 2025 01:17
README.md Outdated
### How can I get set up to contribute to the site?

1. Set up GitHub
2. Set up Ruby (TODO: is this needed to keep _site files up to date?)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to figure this out and will update.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per #13 maybe we don't want to keep this up to date given the complexity of the installation. We can keep the instructions for setting up Ruby there, but qualify them as needed if you're making a specific kind of site changes, but not require them for all checkins. We should set up a flow for deployment (#22)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Address this in #23

README.md Outdated
### How can I myself as a person to the site or update my person profile?

1. Where are the people files
2. What is the meta-data required (TODO: do we need a separate data model README?)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to think about this; maybe it can go in this README.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Address this in #23

@alt-thompson alt-thompson marked this pull request as ready for review November 19, 2025 21:48
@alt-thompson
Copy link
Collaborator Author

FYI @alexishiniker: updates to site README

@alt-thompson alt-thompson merged commit e9a3081 into main Nov 19, 2025
@alt-thompson alt-thompson deleted the first-readme-update branch November 19, 2025 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants