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 docs #284

Merged
merged 20 commits into from
Apr 29, 2024
Merged

Add docs #284

merged 20 commits into from
Apr 29, 2024

Conversation

sydney-runkle
Copy link
Member

@sydney-runkle sydney-runkle commented Apr 25, 2024

TODO:

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

Down the line:

  • Embed iframes with HTML renderings of sample components in the API docs!
  • Use attribute docstrings to make typescript docs more comprehensive (@Viicos, I'm not yet done with this PR, but figured you might be interested in helping with this down the line)!

Closes #278

Copy link

cloudflare-workers-and-pages bot commented Apr 25, 2024

Deploying fastui with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4ce85d4
Status: ✅  Deploy successful!
Preview URL: https://1105d53b.fastui.pages.dev
Branch Preview URL: https://add-docs.fastui.pages.dev

View logs

first pass at docs update logic

add permission

fix requirements install

more docstrings

download fix
@sydney-runkle
Copy link
Member Author

Very helpful for this, thanks @pawamoy!!

mkdocstrings/mkdocstrings#636 (comment)

incremental progress on typescript docs

removing explicit typescript declaration

getting typescript docs working

let's see if secret works

update token name

bump version

typedoc install

npm install

specifically typedoc

global install

switching up version again

using 3.11

npm install, broad

modify env var syntax
@sydney-runkle
Copy link
Member Author

Merging this first pass at docs work, I'm sure there's much more to be done!

Also, will serve as a test for the docs-site build logic, which I'm sure needs to be improved (or fixed).

@sydney-runkle sydney-runkle merged commit dc9bab1 into main Apr 29, 2024
16 checks passed
@sydney-runkle sydney-runkle deleted the add-docs branch April 29, 2024 12:56
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.

Add documentation via mkdocs-material 😎
1 participant