Fi docs style checker

[iamfortune]

No description provided.

[github-actions]

📝 Doc Style Checker Results

❌ test-doc.adoc

Error: HTTP 500: {"error":"Failed to analyze content"}

🎉 All documentation looks great! No style issues found.

---

Automated by Doc Style Checker • Couchbase Documentation Style Guide

[github-actions]

📝 Doc Style Checker Results

❌ test-doc.adoc

Error: HTTP 500: {"error":"Test failed","details":"Unterminated string in JSON at position 4250 (line 1 column 4251)"}

🎉 All documentation looks great! No style issues found.

---

Automated by Doc Style Checker • Couchbase Documentation Style Guide

[github-actions]

📝 Doc Style Checker Results

🔍 Summary: 1 issue found across 1 file

📋 test-doc.adoc

1 issue found

Test Category

Issue 1

Problem: This is a test issue

Text:

Data Modelling

couchbase Sync Gateway’s data mode

Location: Test location

Suggestion: This is a test suggestion

Guideline: Test guideline

---

Automated by Doc Style Checker • Couchbase Documentation Style Guide

[github-actions]

📝 Doc Style Checker Results

🔍 Summary: 17 issues found across 1 file

📋 test-doc.adoc

17 issues found

General Style

Issue 1

Problem: The heading should be in title case.

Text:

Data Modelling

Location: Heading

Suggestion: Data Modeling

Guideline: Couchbase Style Guide: General Principles (Capitalization of headings)

Issue 2

Problem: Avoid using the future tense.

Text:

that you want to replicate using Sync Gateway.

Location: Paragraph 1

Suggestion: that you replicate using Sync Gateway.

Guideline: Couchbase Style Guide: Write in the Present Tense

Issue 3

Problem: Use plain language. 'Relating to' can be simplified to 'for'.

Text:

guidance and constraints relating to the design of data buckets

Location: Paragraph 1

Suggestion: guidance and constraints for the design of data buckets

Guideline: Couchbase Style Guide: Use Plain Language

Issue 4

Problem: Use contractions where appropriate.

Text:

does not

Location: Paragraph 2

Suggestion: doesn't

Guideline: Couchbase Style Guide: Use Plain Language and Contractions

Issue 5

Problem: Use plain language. 'Encounter' is less direct than 'see'.

Text:

When you might encounter the error

Location: Section: When you might encounter the error

Suggestion: When you might see the error

Guideline: Couchbase Style Guide: Use Plain Language

Issue 6

Problem: The phrase 'the following error' is redundant. The subsequent information indicates an error.

Text:

the following error:

Location: Section: For versions 2.x of Sync Gateway, you can encounter the following error:

Suggestion: the error:

Guideline: Couchbase Style Guide: Use Plain Language

Issue 7

Problem: Avoid overly formal language. Use a more direct construction.

Text:

How to avoid the error

Location: Section: How to avoid the error

Suggestion: Avoiding the error

Guideline: Couchbase Style Guide: Use Plain Language

Issue 8

Problem: Use the active voice. The passive voice construction makes the sentence less direct and harder to read.

Text:

be rejected by Sync Gateway

Location: Paragraph 3

Suggestion: Sync Gateway rejects

Guideline: Couchbase Style Guide: Use Active Voice

Issue 9

Problem: Shorten sentences for clarity.

Text:

Couchbase’s unit of data is a document, this is the NOSQL equivalent of a row or record.

Location: Section: Document Structure

Suggestion: Couchbase's unit of data is a document. This is the NoSQL equivalent of a row or record.

Guideline: Couchbase Style Guide: Use Simple Sentences and Short Paragraphs

Issue 10

Problem: Use simple sentences and short paragraphs. Break up the sentence for easier readability

Text:

These attachments provide a means to store large media files or any other non-textual data. Couchbase Lite supports attachments of unlimited size, although the Sync Gateway imposes a 20MB limit for attachments synced to it.

Location: Section: Value

Suggestion: These attachments provide a means to store large media files or any other non-textual data. Couchbase Lite supports attachments of unlimited size. Sync Gateway imposes a 20MB limit for attachments synced to it.

Guideline: Couchbase Style Guide: Use Simple Sentences and Short Paragraphs

Issue 11

Problem: Use the active voice

Text:

A document ID

Location: Section: Document Attributes

Suggestion: Each document has an ID

Guideline: Couchbase Style Guide: Use Active Voice

Capitalization

Issue 1

Problem: Lowercase 'introduction' as it's a standard section heading.

Text:

introduction

Location: Heading

Suggestion: Introduction

Guideline: Couchbase Style Guide: General Principles (Capitalization of headings)

Issue 2

Problem: Capitalize 'Id' when referring to the document key.

Text:

the Id

Location: Section: Value

Suggestion: the ID

Guideline: Couchbase Style Guide: General Principles (Product names and technical terms)

Issue 3

Problem: Capitalize 'Id' when referring to the document key.

Text:

the Id

Location: Section: Key

Suggestion: the ID

Guideline: Couchbase Style Guide: General Principles (Product names and technical terms)

Writing Structure

Issue 1

Problem: The list of 'Document Attributes' could benefit from being presented as a bulleted list for improved readability.

Text:

Each Document has the following attributes: ...

Location: Section: Document Attributes

Suggestion: Use a bulleted list to present the document attributes.

Guideline: Couchbase Style Guide: Use Simple Sentences and Short Paragraphs (Break up text with lists)

Google Style Guidelines

Issue 1

Problem: Prefer 'for example' over 'e.g.' for clarity.

Text:

e.g.

Location: Multiple locations (e.g., Section: Document Attributes)

Suggestion: For example,

Guideline: Google Developer Style Guide: Abbreviations (Avoid abbreviations that are not widely understood.)

References

Issue 1

Problem: Incomplete reference; 'Example 1' needs to be expanded to provide more context and clarity. Referencing within the same document is generally discouraged.

Text:

see Example 1 for the error details

Location: Property naming

Suggestion: see the error details under 'Property prefix error message'

Guideline: Writing Concepts + Writing Procedures (linking conventions)

---

Automated by Doc Style Checker • Couchbase Documentation Style Guide

[github-actions]

📝 Doc Style Checker Results

🔍 Found 17 style issues in 1 file

📋 test-doc.adoc

General Style

▼ Issue 1

Problem: The heading 'introduction' should be capitalized as 'Introduction'. Headings should be properly capitalized.

Text:

introduction

Location: Heading before the introductory paragraph

Suggestion: Change to 'Introduction'

Guideline: General principle of clear and consistent writing; implicit in example headings.

---

▼ Issue 2

Problem: Use present tense. 'They do not necessarily align with constraints' should be rephrased.

Text:

They do not necessarily align with constraints

Location: Introduction, paragraph 1

Suggestion: They don't necessarily align with constraints

Guideline: Write in the Present Tense

---

▼ Issue 3

Problem: Use contractions. 'do not' should be 'don't'.

Text:

do not

Location: Introduction, paragraph 1

Suggestion: don't

Guideline: Use Plain Language and Contractions

---

▼ Issue 4

Problem: Use contractions. 'does not' should be 'doesn't'.

Text:

doesn’t

Location: How to avoid the error

Suggestion: doesn't

Guideline: Use Plain Language and Contractions

---

▼ Issue 5

Problem: Avoid starting a sentence with 'Any'. Reword the sentence for better flow and clarity.

Text:

Any document that matches the reserved property names listed will be rejected by Sync Gateway — see Example 1 for the error details.

Location: Property Naming, paragraph 2

Suggestion: Sync Gateway rejects any document that matches the reserved property names. See Example 1 for error details.

Guideline: Use Simple Sentences and Short Paragraphs; Active Voice (improves flow)

---

▼ Issue 6

Problem: Prefer 'can' over 'may' when indicating possibility. 'May encounter' should be 'can encounter'.

Text:

You may encounter the error

Location: When you might encounter the error

Suggestion: You can encounter the error

Guideline: Plain language (avoiding overly formal language)

---

▼ Issue 7

Problem: Avoid starting a sentence with 'For'. Reword the sentence.

Text:

For versions 2.x of Sync Gateway, you can encounter the following error:

Location: When you might encounter the error, second bullet

Suggestion: In Sync Gateway versions 2.x, you can encounter the following error:

Guideline: Use Simple Sentences and Short Paragraphs; Active Voice (improves flow)

---

▼ Issue 8

Problem: Avoid using phrases like 'How to avoid the error'. Be more direct.

Text:

How to avoid the error

Location: Heading

Suggestion: Avoiding the error

Guideline: Voice and Tone: Aim to keep a neutral tone in the documentation. Think about what drove the user to the documentation and try to be as helpful and to-the-point as possible. Give them what they need to be successful.

---

▼ Issue 9

Problem: The phrase 'users' data' is awkward. Use 'user data' or 'data'.

Text:

users' data

Location: Document Structure, paragraph 2

Suggestion: user data

Guideline: Use Plain Language

---

▼ Issue 10

Problem: The phrase 'that is' can be simplified to 'that's'.

Text:

that is

Location: Key, paragraph 4

Suggestion: that's

Guideline: Use Plain Language and Contractions

---

▼ Issue 11

Problem: The phrase 'A JSON value, termed a Document' is awkward. 'Termed' can be removed or rephrased for clarity.

Text:

A JSON value, termed a Document.

Location: Value, paragraph 2

Suggestion: A JSON value (a document).

Guideline: Use Plain Language

---

Capitalization

▼ Issue 12

Problem: 'couchbase' should be capitalized as 'Couchbase' since it is a product name.

Text:

couchbase Sync Gateway’s data model

Location: Title

Suggestion: Couchbase Sync Gateway’s data model

Guideline: If Vale flags a product name or other technical industry term as incorrect: If it’s a phrase or single word that must have specific capitalization, add it to the Vocab\Couchbase\accept.txt file.

---

▼ Issue 13

Problem: 'sync gateway' should be capitalized as 'Sync Gateway' since it is a product name.

Text:

sync gateway

Location: Title, Introduction, and throughout document

Suggestion: Sync Gateway

Guideline: If Vale flags a product name or other technical industry term as incorrect: If it’s a phrase or single word that must have specific capitalization, add it to the Vocab\Couchbase\accept.txt file.

---

▼ Issue 14

Problem: 'Id' should be 'ID'.

Text:

Id

Location: Document Structure, Key paragraphs, and Value

Suggestion: ID

Guideline: If Vale flags a product name or other technical industry term as incorrect: If it’s a phrase or single word that must have specific capitalization, add it to the Vocab\Couchbase\accept.txt file.

---

▼ Issue 15

Problem: 'NOSQL' should be 'NoSQL'.

Text:

NOSQL

Location: Document Structure, paragraph 1

Suggestion: NoSQL

Guideline: If Vale flags a product name or other technical industry term as incorrect: If it’s a phrase or single word that must have specific capitalization, add it to the Vocab\Couchbase\accept.txt file.

---

Writing Structure

▼ Issue 16

Problem: Long sentences need to be broken down. 'Search Service indexes are not the same as Index Service indexes. If you deploy the Index Service, Query Service, and Search Service on the same cluster, you can use the Search Service through the N1QL query language.' This sentence is too long and complex.

Text:

Search Service indexes are not the same as Index Service indexes. If you deploy the Index Service, Query Service, and Search Service on the same cluster, you can use the Search Service through the N1QL query language.

Location: Plain Language and Contractions example (modified from original)

Suggestion: Search Service indexes differ from Index Service indexes. When you deploy the Index, Query, and Search Services on the same cluster, you can access Search Service through the N1QL query language.

Guideline: Use Simple Sentences and Short Paragraphs

---

Google Style Guidelines

▼ Issue 17

Problem: In code samples, the use of curly quotes (“ and ”) is discouraged.

Text:

“{"error":"Bad Request","reason":"user defined top level properties beginning with '_' are not allowed in document body"}”

Location: Example 1. Property prefix error message

Suggestion: {"error":"Bad Request","reason":"user defined top level properties beginning with '_' are not allowed in document body"}

Guideline: Google Developer Style Guide: Code samples should use straight quotes.

---

---

Automated by Doc Style Checker using Couchbase Documentation Style Guide

[github-actions]

📝 Doc Style Checker Results

🔍 Found 10 style issues in 1 file

📋 test-doc.adoc

General Style

▼ Issue 1

Problem: Inconsistent use of contractions. The style guide encourages contractions, except for negative constructions, but the content doesn't consistently use them.

Text:

does not

Location: Introduction

Suggestion: Use 'doesn't' instead of 'does not'.

Guideline: Use Plain Language and Contractions

---

▼ Issue 2

Problem: Sentence exceeds 25 words.

Text:

This page includes guidance and constraints relating to the design of data buckets and documents that you want to replicate using Sync Gateway.

Location: Introduction

Suggestion: Split the sentence into two shorter sentences. For example: 'This page provides guidance and constraints for designing data buckets and documents. These are intended for replication using Sync Gateway.'

Guideline: Use Simple Sentences and Short Paragraphs

---

▼ Issue 3

Problem: Sentence exceeds 25 words.

Text:

Couchbase Lite supports attachments of unlimited size, although the Sync Gateway imposes a 20MB limit for attachments synced to it.

Location: Value Section

Suggestion: Split into two sentences: 'Couchbase Lite supports attachments of unlimited size. However, Sync Gateway limits attachments synced to it to 20MB.'

Guideline: Use Simple Sentences and Short Paragraphs

---

▼ Issue 4

Problem: Use present tense.

Text:

listed will be rejected

Location: Property Naming

Suggestion: listed are rejected

Guideline: Write in the Present Tense

---

Capitalization

▼ Issue 5

Problem: Inconsistent capitalization of 'Id'. Sometimes it's capitalized, sometimes it's not. Choose one and stick to it.

Text:

the Id

Location: Document Structure

Suggestion: Use 'ID' (all caps) or 'id' (all lowercase) consistently. Given the technical context, 'ID' is preferable.

Guideline: N/A - Internal Consistency

---

▼ Issue 6

Problem: The word 'document' should be lowercase when referring to the general concept, and capitalized when it is a specific object.

Text:

Each Document has the following attributes

Location: Document Attributes

Suggestion: Each document has the following attributes

Guideline: N/A - Internal Consistency

---

▼ Issue 7

Problem: Incorrect capitalization of Couchbase Lite

Text:

couchbase Sync Gateway

Location: Title

Suggestion: Couchbase Sync Gateway

Guideline: N/A - Correct Product Name

---

Writing Structure

▼ Issue 8

Problem: The introduction lacks a :description: attribute. All concepts and procedures should have one.

Text:

introduction

This page includes guidance and constraints relating to the design of data buckets and documents that you want to replicate using Sync Gateway. They do not necessarily align with constraints on the local storage and use of such documents.

Location: Introduction

Suggestion: Add a :description: attribute above the introduction. Example: :description: Learn about the data model for Couchbase Sync Gateway and its implications for data replication.

Guideline: Writing Concepts & Procedures: Description Attribute

---

▼ Issue 9

Problem: Missing 'See Also' section. Concepts require a 'See Also' section with related links.

Text:

Document Change History
Couchbase Lite tracks the change history of every document as a series of revisions, like version control systems such as Git or Subversion. Its main purpose is to enable the replicator to determine which data to sync and any conflicts arising.

Location: End of Document Change History

Suggestion: Add a 'See Also' section with links to relevant documentation.

Guideline: Writing Concepts: See Also

---

Google Style Guidelines

▼ Issue 10

Problem: Use straight quotes instead of curly quotes.

Text:

users’

Location: Value section

Suggestion: users'

Guideline: Google Developer Style Guide - Quotes

---

---

Automated by Doc Style Checker using Couchbase Documentation Style Guide

[github-actions]

📝 Doc Style Checker Results

🔍 Found 8 style issues in 1 file

📋 test-doc.adoc

General Style

▼ Issue 1

Problem: Inconsistent tense usage. The document should consistently use the present tense.

Text:

that you want to replicate using Sync Gateway.

Location: Introduction

Suggestion: that you replicate using Sync Gateway.

Guideline: Write in the Present Tense

---

▼ Issue 2

Problem: Use contractions where appropriate.

Text:

does not

Location: Introduction

Suggestion: doesn't

Guideline: Use Plain Language and Contractions

---

▼ Issue 3

Problem: Sentences are longer than 25 words.

Text:

In Mobile-to-Web Data Sync with Node.js Server SDK and Ottoman.js (the Node.js ODM for Couchbase), where the rule conflicts with the _type property that is automatically added by Ottoman.js.

Location: When you might encounter the error

Suggestion: In Mobile-to-Web Data Sync with Node.js Server SDK and Ottoman.js (the Node.js ODM for Couchbase), the rule conflicts with the _type property that Ottoman.js automatically adds.

Guideline: Use Simple Sentences and Short Paragraphs

---

▼ Issue 4

Problem: Avoid starting a sentence with 'Where'.

Text:

Where it applies

Location: Section after Example 1

Suggestion: Applicability

Guideline: Use Active Voice

---

▼ Issue 5

Problem: Sentence exceeds the recommended length.

Text:

This JSON object is a collection of key/value pairs. The values may be numbers, strings, arrays, or even nested objects. As a result, documents can represent complex data structures in a readily parsable and self-organizing manner.

Location: Value section, JSON value

Suggestion: This JSON object is a collection of key/value pairs. The values can be numbers, strings, arrays, or nested objects. Documents represent complex data structures in a readily parsable and self-organizing way.

Guideline: Use Simple Sentences and Short Paragraphs

---

Capitalization

▼ Issue 6

Problem: Inconsistent capitalization of 'id'. It should consistently be 'Id' when referring to the document key.

Text:

the Id

Location: Document Structure, Key section

Suggestion: the Id

Guideline: Follow established capitalization conventions for technical terms

---

▼ Issue 7

Problem: Incorrect capitalization. Should be 'JSON'.

Text:

a JSON value

Location: Value section, JSON value

Suggestion: a JSON value

Guideline: Follow established capitalization conventions for technical terms

---

Writing Structure

▼ Issue 8

Problem: The 'How to avoid the error' section could be better structured as a procedure with clear, numbered steps.

Text:

You should change any top-level user properties that have a key with a leading underscore , by either:

Renaming them to remove the underscore, or,

Wrapping them inside another object with a key that doesn’t have a leading underscore.

Location: How to avoid the error

Suggestion: To avoid the error, follow these steps:

1. Rename any top-level user properties with a leading underscore to remove the underscore.
2. Alternatively, wrap the properties inside another object with a key that doesn't have a leading underscore.

Guideline: Writing Procedures

---

---

Automated by Doc Style Checker using Couchbase Documentation Style Guide

[github-actions]

Automated review comment from Gemini AI:

Suggested change

	Data moeeldelling
	Data moeeldelling

Style Guide Issues Found:

• Couchbase.GeneralStyle (warning) - Use contractions.

---

Powered by Doc Style Checker using Couchbase Documentation Style Guide

[github-actions]

Automated review comment from Gemini AI:

Suggested change

	couchbase Sync Gateway’s data model; for secure cloud-to-edge synchronization of enterprise data.
	couchbase Sync Gateway’s data model; for secure cloud-to-edge synchronization of enterprise data.

Style Guide Issues Found:

• Couchbase.GeneralStyle (error) - Write in the present tense.
• Couchbase.GeneralStyle (warning) - Use contractions.
• Couchbase.Capitalization (error) - Inconsistent capitalization of 'Id'.
• Couchbase.WritingStructure (warning) - Sentence exceeds 25 words.

---

Powered by Doc Style Checker using Couchbase Documentation Style Guide

[github-actions]

Automated review comment from Gemini AI:

Suggested change

	_id
	_id

Style Guide Issues Found:

• Couchbase.Capitalization (error) - Inconsistent capitalization of 'Id'.

---

Powered by Doc Style Checker using Couchbase Documentation Style Guide