Skip to content

Beautiful README, updated docs, and favicon#31

Merged
neyec merged 12 commits into
mainfrom
feature/beautiful-readme
May 27, 2026
Merged

Beautiful README, updated docs, and favicon#31
neyec merged 12 commits into
mainfrom
feature/beautiful-readme

Conversation

@neyec

@neyec neyec commented May 27, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Polished README with Norma logo, tagline, badges, screenshot, feature descriptions, architecture diagram, and docs table
  • New getting started guide (docs/getting-started.md)
  • Updated all docs: architecture, API reference, chat agent, document processing, deployment
  • Replaced favicon with Norma petal icon
  • Replaced .empty placeholder with /dev/null in docker-compose.yml

Closes #20

Test plan

  • Verify README renders correctly on GitHub (logo, badges, mermaid diagram, screenshot)
  • Confirm all internal links resolve
  • Check favicon appears in browser tab

🤖 Generated with Claude Code

neyec and others added 12 commits May 27, 2026 14:07
Closes #20

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add docs/getting-started.md with step-by-step setup walkthrough
- Update architecture.md with GitHub integration, multi-framework
  support, i18n, and Integration/GitHubTask/GitHubRepoFile models
- Update api-reference.md with integrations endpoints, debug context
  endpoint, and document upload delete endpoint
- Update chat-agent.md with codebase context, language support, and
  debug context viewer
- Update document-processing.md with GitHub processing pipeline
- Update deployment.md with multi-framework seeding
- Update README.md docs table to include getting started guide

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@neyec neyec merged commit 6a18456 into main May 27, 2026
3 checks passed
@neyec neyec deleted the feature/beautiful-readme branch May 27, 2026 13:57
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.

Beautiful README

1 participant