Skip to content

Enhance README with project overview, architecture, and quickstart guide#24

Open
tobias-weiss-ai-xr wants to merge 1 commit intoEuro-Office:mainfrom
tobias-weiss-ai-xr:docs/enhance-readme
Open

Enhance README with project overview, architecture, and quickstart guide#24
tobias-weiss-ai-xr wants to merge 1 commit intoEuro-Office:mainfrom
tobias-weiss-ai-xr:docs/enhance-readme

Conversation

@tobias-weiss-ai-xr
Copy link
Copy Markdown

Partially addresses #3

Summary

  • Add proper project description with badges (license, CI)
  • Add component overview table linking to all sub-repositories
  • Add quickstart Docker instructions (prominently placed)
  • Add documentation links section
  • Add build from source, packages, and testing sections
  • Add get involved section with links to issues and contributing guide
  • Keep the existing license badge and Docker try-out section

Partially addresses Euro-Office#3

Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Copy link
Copy Markdown
Member

@juliusknorr juliusknorr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot, one minor comment, and we still need the referenced guides in the .github repo.

# Euro-Office DocumentServer

[Learn more.](https://github.com/Euro-Office/)
**Your sovereign office suite** — A free, open-source document editing platform for collaborative editing of documents, spreadsheets, presentations, and PDFs.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now it would be good to keep the link to the organization as the README there gives a bit more background.. Having the summary explanation makes sense, but can you bring back the link?

## Get Involved

- **File issues**: [github.com/Euro-Office/DocumentServer/issues](https://github.com/Euro-Office/DocumentServer/issues)
- **Submit PRs**: See the [contributing guide](https://github.com/Euro-Office/.github/blob/main/CONTRIBUTING.md)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good point, we should add general contribution guidelines.

@juliusknorr juliusknorr added the documentation Improvements or additions to documentation label Mar 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants