rjayasinghe / docs

CAP Documentation

Documentation for
SAP Cloud Application Programming Model

About this project

This repository contains the core parts of the documentation pages for the SAP Cloud Application Programming Model. As a short name, we refer to the documentation as Capire.

Along with additional SAP-specific pages the content is published to https://cap.cloud.sap on a regular basis.

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports, etc. via GitHub issues and pull requests. Contribution and feedback are encouraged and always welcome.

See our contribution guidelines for information about how to contribute, the project structure, as well as additional contribution information.

Running Locally

If you contribute often to the documentation it's best to create your own fork, clone it to your local machine.

git clone https://github.com/cap-js/docs   # or whatever your fork's URL is

Install the dependencies:

npm run setup

Start the local server:

npm run start

This will respond with:

  vitepress v1...

  ➜  Local:   http://localhost:5173/docs/
  ➜  Network: use --host to expose
  ➜  press h to show help

Once this is running, if you are reading this documentation at https://cap.cloud.sap/,

• press l to open the page on localhost
• and then press o to open the page in your local VS Code

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 at all times.

Licensing

Copyright 2023-2024 SAP SE or an SAP affiliate company and CAP contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.