Project Info

This project did not submit a demo video on Devpost.

Inspiration

Tired of writing tedious technical documentation, I sought a solution that could generate human-readable, practical documentation. Pier allows me to save time focusing on writing code knowing I can work with a readable documentation without any writing of my own.

What it does

Pier generates readable documentation.

How we built it

Build using Rust to iterate fast over file directories and for file text processing. Using AI for creating readable documentation, and MkDocs for quick documentation site deployment.

Challenges we ran into

Working with optimizing for performance was challenging.

Accomplishments we're proud of

Versatility with regards to input and output locations for project codebases and doc generation.

What we learned

First time working with the OpenAI API and MkDocs. Also how to reduce overhead for performance.

What's next

AI: Fine-tuning, local models Performance: Reducing overhead, faster file processing

Analysis

Compare with all teams

View

Metric

Figures cover GitHub contributors during the hackathon window. A co-authored commit counts in full for each author, so per-member totals add up to more than the whole-team figures.

Technology

Found in codeClaimed only
  • CIn code
  • OpenAIIn code
  • RustIn code

3 of 3 appear in the indexed code.

AI coding agents

No AI coding agent signals were found in this repository.

Detected from committed agent config files and commit authorship. Absence of a signal is not proof an agent was unused.

Codebase size

Source size

9.5 KB

Source files

5

Counts recognized source files only; vendored directories, binaries and lockfiles are excluded, so this is smaller than the repository on disk.

0 stars