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

WIP: add docs via mkdocs ✍️ #280

Closed
wants to merge 15 commits into from
Closed

WIP: add docs via mkdocs ✍️ #280

wants to merge 15 commits into from

Conversation

sydney-runkle
Copy link
Member

@sydney-runkle sydney-runkle commented Apr 23, 2024 •
edited
Loading

TODO:

  • Get CI docs build working (tuesday)
  • Add docs for Python types (tuesday)
  • Write intro content (tuesday)
  • Add docs for TypeScript types (thursday)
  • Write guide content (thursday)
  • Configure docs site via CloudFlare (friday)

samuelcolvin
samuelcolvin reviewed Apr 24, 2024
View reviewed changes
mkdocs.yml

# TODO: add flarelytics support
# extra_javascript:
# - '/flarelytics/client.js'
Copy link
Member

Choose a reason for hiding this comment

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

let's remember to enable this.

samuelcolvin
samuelcolvin approved these changes Apr 24, 2024
View reviewed changes
Copy link
Member

@samuelcolvin samuelcolvin left a comment

Choose a reason for hiding this comment

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

From a brief scan, this looks like a great start.

Do we need the boilerplate to build the docs at docs-site like we do for pydantic?

@sydney-runkle
Copy link
Member Author

Yep, definitely. Thanks for the initial review!

@sydney-runkle
Copy link
Member Author

Closing and reopening to see if I can get a docs preview going.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@samuelcolvin samuelcolvin samuelcolvin approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sydney-runkle @samuelcolvin