Skip to content

Docs infra#156

Merged
alxmrs merged 13 commits into
xqlsystems:mainfrom
ahuang11:docs_infra
Mar 27, 2026
Merged

Docs infra#156
alxmrs merged 13 commits into
xqlsystems:mainfrom
ahuang11:docs_infra

Conversation

@ahuang11

@ahuang11 ahuang11 commented Mar 26, 2026

Copy link
Copy Markdown
Collaborator

Creates a doc page using zensical and fixes a few new line issues in the docs and typing warnings raised by griffe.

image

Also adds a new logo; feel free to change as necessary.

Upon merge, need to enable Pages > Github action

image

@ahuang11
ahuang11 requested a review from alxmrs March 26, 2026 20:39

@alxmrs alxmrs left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Wonderful! Thanks for this contribution, I can't wait to see the site up!

Comment thread .github/workflows/docs.yml Outdated
Comment thread .github/workflows/docs.yml Outdated
Comment thread .github/workflows/docs.yml Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
You can also run the hooks manually with: `uv run pre-commit run --all-files`
4. Build and serve docs locally: `uv run zensical serve`


Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

TODO(me): update this doc with steps to build native sources and dev locally.

Comment thread zensical.toml Outdated
Comment thread zensical.toml
@alxmrs

alxmrs commented Mar 26, 2026

Copy link
Copy Markdown
Collaborator

Let's fix lint before merge ofc.

@alxmrs

alxmrs commented Mar 26, 2026

Copy link
Copy Markdown
Collaborator

I like the logo!

@alxmrs

alxmrs commented Mar 26, 2026

Copy link
Copy Markdown
Collaborator

Op. I broke the lint check. Will fix.

@ahuang11

Copy link
Copy Markdown
Collaborator Author

I'll let you re-run tests and merge

@ahuang11

Copy link
Copy Markdown
Collaborator Author

I have no idea why lint for README is failing; it's not failing locally :(

@ahuang11
ahuang11 requested a review from alxmrs March 26, 2026 22:21

@alxmrs alxmrs left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@alxmrs
alxmrs merged commit f270bbf into xqlsystems:main Mar 27, 2026
12 checks passed
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