https://github.com/couchbase/docs-sdk-c
Couchbase C SDK docs (asciidoc)
https://github.com/couchbase/docs-sdk-c
docs
Last synced: 9 months ago
JSON representation
Couchbase C SDK docs (asciidoc)
- Host: GitHub
- URL: https://github.com/couchbase/docs-sdk-c
- Owner: couchbase
- License: other
- Created: 2018-07-20T19:20:01.000Z (almost 8 years ago)
- Default Branch: release/3.3
- Last Pushed: 2025-10-06T10:58:36.000Z (9 months ago)
- Last Synced: 2025-10-06T12:34:47.162Z (9 months ago)
- Topics: docs
- Language: C++
- Homepage: https://docs.couchbase.com
- Size: 2.05 MB
- Stars: 1
- Watchers: 13
- Forks: 22
- Open Issues: 3
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
= Couchbase C SDK Documentation
// Settings:
ifdef::env-github[]
:warning-caption: :warning:
endif::[]
// URLs:
:url-org: https://github.com/couchbase
:url-contribute: https://docs.couchbase.com/home/contribute/index.html
:url-ui: {url-org}/docs-ui
:url-playbook: {url-org}/docs-site
This repository hosts the documentation source for the Couchbase C SDK.
== Contributing
Check out our {url-contribute}[contributing guide] to learn how to:
* submit a bug or feedback issue
* set up your documentation workspace
* build the documentation
* submit a pull request
Thank you for helping to make the documentation better.
== Docs Component Configuration
This repository contains an Antora docs component.
Keep in mind these key repository features:
* Component name, version, and start page are configured in each branch's _antora.yml_ file.
* The navigation for all of the modules is stored in the ROOT module's _nav.adoc_ file.
* Production branches use the *release/X.Y* naming pattern (e.g., release/5.5, release/6.0).
** The {url-playbook}[docs site playbook] instructs Antora to automatically aggregate any branch names that start with *release/*.
== Documentation Site Toolchain
The documentation source files are marked up with AsciiDoc.
Once merged into a version branch, the source files and their assets are aggregated, converted to HTML, and published by Antora to our staging and production sites.
The docs components and {url-ui}[site UI] are orchestrated by the {url-playbook}[docs site playbook].
See the contributing guide to learn more.
== Docs License
©2025 Couchbase, Inc. This work is licensed under CC BY-NC-SA 4.0.