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.

Sign up for GitHub

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

Jump to bottom

Add book (WIP) #46

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add book (WIP) #46

wants to merge 1 commit into from

Conversation

cassaundra
Copy link
Collaborator

@cassaundra cassaundra commented Jan 30, 2024 •
edited

Add book to be published to https://quake.build.

Most pages (those without a link in SUMMARY.md) will not be written as part of this PR.

Closes #27 and #28.

To-do

Pages:

  • Introduction
  • Installation
  • Guide
    • Initializing a project
    • Tasks (WIP)
    • Concurrency
    • File watching and reloading
  • Cookbook
  • Reference

Tasks:

  • Clean up README demo to point to documentation instead
  • Choose a different default theme (Ayu?)
  • Add GitHub Actions workflow to deploy to site
  • Split up commits before merging

@cassaundra cassaundra added the documentation Improvements or additions to documentation label Jan 30, 2024
@cassaundra cassaundra marked this pull request as draft January 30, 2024 07:34
@cassaundra cassaundra added this to the quake 0.1.0 milestone Jan 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
quake
Status: In progress
Milestone
quake 0.1.0
Development

Successfully merging this pull request may close these issues.

Set up Markdown book with automatic deployment
1 participant
@cassaundra