https://github.com/fr4iser90/aboutme

A personal "About Me" web page with editable content and backend support. Includes API or UI for managing text, links, and other profile sections.
https://github.com/fr4iser90/aboutme

about-me backend editable fastapi nextjs personal-website profile selfhosted tailwind

Last synced: about 2 months ago
JSON representation

A personal "About Me" web page with editable content and backend support. Includes API or UI for managing text, links, and other profile sections.

• Host: GitHub
• URL: https://github.com/fr4iser90/aboutme
• Owner: fr4iser90
• License: mit
• Created: 2025-05-28T07:35:08.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-06-29T19:48:20.000Z (12 months ago)
• Last Synced: 2025-06-29T20:35:13.902Z (12 months ago)
• Topics: about-me, backend, editable, fastapi, nextjs, personal-website, profile, selfhosted, tailwind
• Language: TypeScript
• Homepage: https://fr4iser.com
• Size: 5.94 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: docs/README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# AboutMe Project Documentation

This documentation is structured to support both human developers and AI-assisted development. It follows modern documentation practices and is optimized for LLM integration.

## Directory Structure

- `/architecture` - System architecture, design decisions, and technical specifications

- `/api` - API documentation, endpoints, and integration guides

- `/development` - Development setup, workflows, and coding standards

- `/deployment` - Deployment procedures, environments, and infrastructure

- `/llm` - LLM-specific documentation, prompts, and integration guides

- `/guides` - Step-by-step guides and tutorials

- `/reference` - Technical reference materials and specifications

## Documentation Standards

1. All documentation is written in Markdown format

2. Code examples are provided in both Python and TypeScript

3. Each section includes:

   - Clear objectives

   - Prerequisites

   - Step-by-step instructions

   - Troubleshooting guides

   - Related resources

## LLM Integration

This documentation is designed to be LLM-friendly with:

- Clear section headers

- Consistent formatting

- Explicit context markers

- Code examples with comments

- Structured data formats

## Contributing

When adding new documentation:

1. Follow the established directory structure

2. Include both human-readable and LLM-friendly content

3. Add appropriate metadata and tags

4. Update the relevant README.md files

5. Include code examples where applicable

## Quick Links

- [Architecture Overview](architecture/README.md)

- [API Documentation](api/README.md)

- [Development Guide](development/README.md)

- [Deployment Guide](deployment/README.md)

- [LLM Integration Guide](llm/README.md)

- [User Guides](guides/README.md)

- [Technical Reference](reference/README.md)