Add AgentFinVQA project website#17
Merged
Merged
Conversation
…e assets. Removed deprecated index.md, added main.js for navigation functionality, and updated styles in style.css. Enhanced GitHub Actions workflow to include JPEG and JPG file types and updated uv version." This reverts commit 9fdf9dd.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a public project landing page for AgentFinVQA on GitHub Pages: paper-style homepage with teaser figure, abstract, method, results, and quick-start sections. Replaces the generic MkDocs template docs with a single static site served from
docs/index.html.Clickup Ticket(s): N/A
Type of Change
Changes Made
docs/index.html— single-column project homepage (title/authors → teaser → intro, abstract, method, dataset, results, quick start, BibTeX)docs/style.cssanddocs/main.js(nav toggle, code copy, BibTeX copy)Teaser.jpeg,Teaser_color.jpegdocs/user_guide.md,docs/api.md,docs/index.mdmkdocs.yml— landing page only (removed nav, mkdocstrings plugin, unused markdown extensions).github/workflows/docs.ymlto trigger docs builds on.jpeg/.jpgchangesTesting
uv run pytest tests/)uv run mypy <src_dir>)uv run ruff check src_dir/)Manual testing details:
uv run mkdocs build— site builds successfully;docs/index.htmland assets copied tosite/Screenshots/Recordings
Homepage includes FinMME qualitative teaser (
docs/assets/Teaser.jpeg) with zero-shot vs agent comparison figure.Related Issues
N/A
Deployment Notes
maintriggers the docs workflow and deploys to GitHub Pages (gh-pages)Checklist