Skip to content

Edit README.md #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zdover23 merged 1 commit into from
Apr 22, 2026
+24 −7
Merged

Edit README.md #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 24 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,45 @@

## About this project

This is the official CobalCore documentation.
This is the official CobaltChore documentation.

## Requirements and Setup

### Docker Compose

$ docker compose up

to bring up a auto-refreshable developoment version of the documentation.
The documentation is accessible via [http://localhost:5173/]().
Run the above command to bring up an auto-refreshable development version of
the documentation. The documentation is accessible via
[http://localhost:5173/]().

## Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cobaltcore-dev/docs/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
This project is open to feature requests and suggestions, bug reports etc. via
[GitHub issues](https://github.com/cobaltcore-dev/docs/issues). Contribution
and feedback are encouraged and always welcome. For more information about how
to contribute, the project structure, as well as additional contribution
information, see our [Contribution Guidelines](CONTRIBUTING.md).

## Security / Disclosure
If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/cobaltcore-dev/.github/blob/main/SECURITY.md) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
If you find any bug that may be a security problem, please follow our
instructions at [in our security
policy](https://github.com/cobaltcore-dev/.github/blob/main/SECURITY.md) on how
to report it. Please do not create GitHub issues for security-related doubts or
problems.

## Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/cobaltcore-dev/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone. By participating in this
project, you agree to abide by its [Code of
Conduct](https://github.com/cobaltcore-dev/.github/blob/main/CODE_OF_CONDUCT.md)
at all times.

## Licensing

Copyright 2025 SAP SE or an SAP affiliate company and CobaltCore contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cobaltcore-dev/docs).
Copyright 2025 SAP SE or an SAP affiliate company and CobaltCore contributors.
Please see our [LICENSE](LICENSE) for copyright and license information.
Detailed information including third-party components and their
licensing/copyright information is available [via the REUSE
tool](https://api.reuse.software/info/github.com/cobaltcore-dev/docs).
Loading