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 athena book #58

Merged
merged 29 commits into from
Jul 30, 2024
Merged

Add athena book #58

merged 29 commits into from
Jul 30, 2024

Conversation

hasanza
Copy link
Collaborator

@hasanza hasanza commented Jul 23, 2024

Adds the Athena Book.

@hasanza hasanza requested a review from lrettig as a code owner July 23, 2024 17:38
@lrettig
Copy link
Contributor

lrettig commented Jul 26, 2024

@hasanza I assumed you'd create the book here by cloning https://github.com/succinctlabs/sp1/tree/main/book, but this looks very different from that. I added some scripts to lint and build the book but they're not working. What did you use as your starting point here?

@hasanza
Copy link
Collaborator Author

hasanza commented Jul 26, 2024

@lrettig I created a book from scratch using mdbook. I thought that would be better than cloning and we could bring in material as needed.

@hasanza
Copy link
Collaborator Author

hasanza commented Jul 26, 2024

@lrettig I investigated the workflow file and it appears that the directory in which the linting, building, and archiving workflows are run is the repository root and not the book directory. I fixed this by adding the correct working directory for the work flows and now everything appears to work properly. And LMK if deployment works properly.

@hasanza
Copy link
Collaborator Author

hasanza commented Jul 29, 2024

Removed the build folder and added it to git ignore in latest commit.

@athenavm athenavm deleted a comment from github-actions bot Jul 29, 2024
lrettig added 2 commits July 29, 2024 16:52
In order to enable the preview to work, it's simplest to use
deploy-from-branch option. Let's try that.
@athenavm athenavm deleted a comment from github-actions bot Jul 30, 2024
Copy link

📘 Book preview available at: https://www.athenavm.org/athena/preview/58/book/

lrettig added a commit to athenavm/athenavm.github.io that referenced this pull request Jul 30, 2024
Works around issue where /athena top-level directory is now used by
athena repository (see athenavm/athena#58)
@lrettig lrettig merged commit 04a2493 into main Jul 30, 2024
8 checks passed
@lrettig lrettig deleted the add-athena-book branch July 30, 2024 20:17
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