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 initial documentation #45

Merged
merged 3 commits into from
Dec 12, 2023
Merged

Add initial documentation #45

merged 3 commits into from
Dec 12, 2023

Conversation

kmaziarz
Copy link
Contributor

This PR adds an initial static documentation built using Material for MkDocs. The docs are built automatically using GitHub Actions and deployed to microsoft.github.io/syntheseus/.

This first version is a combination of content we had in README.md (which is changed here to be very minimalistic, linking to the docs for further information) and the pre-existing docs/cli/eval_single_step.md. In future PRs we can extend the docs with documentation for the search CLI, as well as an API reference and tutorials.

@kmaziarz
Copy link
Contributor Author

Note that rebuilding of the docs happens either when a PR is merged into main or when one triggers it manually from the Actions tab. This means that, when testing a PR that changes the docs, running the action would also publish the changes to be externally visible before the PR is actually merged (although this would only be the case for the final test, as mkdocs can serve the work-in-progress locally; the result of running the action can also be easily reverted by re-running the action from main). This setup seems fine for now, although if we want we could consider enabling some sort of versioning in the future (likely there is a good solution provided by Materials for MkDocs, I just haven't looked into that yet).

Copy link
Collaborator

@AustinT AustinT left a comment

Choose a reason for hiding this comment

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

Looks fantastic Kris, thanks for pushing this forward!

@kmaziarz kmaziarz merged commit 5ed4907 into main Dec 12, 2023
4 checks passed
@kmaziarz kmaziarz deleted the kmaziarz/docs branch December 12, 2023 12:42
kmaziarz added a commit that referenced this pull request Dec 15, 2023
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.

3 participants