Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add developer guide #30

Merged
merged 11 commits into from
Jul 19, 2024
Merged

Add developer guide #30

merged 11 commits into from
Jul 19, 2024

Conversation

edwardchalstrey1
Copy link

Adding an initial development guide to the project documentation.

This PR:

Reviewers should:

  • Check the workflow makes sense and comment if anything is unclear or should change
  • @MajidBenam note: you can build the docs locally or just look at the Files changed tab here in the PR
  • Question for @kallewesterling - are the docs live on GitHub pages already? If not, would be good to enable that and also have a docs preview link to generate on a PR

@kallewesterling
Copy link
Member

They are live already! See deployments here: https://github.com/Seshat-Global-History-Databank/seshat/deployments/github-pages

And here's the GitHub rendering: https://seshat-global-history-databank.github.io/seshat/

Copy link
Member

@kallewesterling kallewesterling left a comment

Choose a reason for hiding this comment

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

Perhaps we should keep TODOs in comments?

The way to do that in RST is:

..
    The comment goes here.

@kallewesterling
Copy link
Member

Otherwise all good, I think!

@edwardchalstrey1
Copy link
Author

@kallewesterling I also removed info from the README that is now duplicated in the docs

@edwardchalstrey1 edwardchalstrey1 merged commit 1a8c076 into dev Jul 19, 2024
2 checks passed
@edwardchalstrey1 edwardchalstrey1 deleted the developer-guide branch July 19, 2024 09:32
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.

Seshat project GitHub workflow proposal & timeline
2 participants