Pier

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 that 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 for Pier

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

Built With

• mkdocs
• openai
• rust
• tokio