Skip to content

docs: move existing pages to the style guide's "native" rules #7358

Open

Description

@Abhishek-Mohan

The documentation style guide added in #7151 (for #4419) applies to new and changed text. Existing pages move over as they are edited. This issue tracks moving the remaining pages to its "native" rules (N1 to N5), so it is easy to see how far that has got.

The list below is a search, not a set of confirmed findings. It counts lines on main (0f90a7d07, 2026-10-30) that match natively, the native path, native operator, native pipeline, native execution, or native engine. Some hits are allowed compounds, quotations, or config keys. Check each one against the guide before changing it.

Not in scope: the changelog, the expression and data source audits, and benchmark results, which the guide treats as records; text between generated-content markers; and the pages #7151 already rewrites.

Once #7153 merges, the review-comet-docs skill's audit mode can review a page or directory against the guide.

.doc(...) strings

  • spark/src/main/scala/org/apache/comet/CometConf.scala (16 lines). These are published in the config reference.

User guide

  • user-guide/latest/expressions.md (53)
  • user-guide/latest/compatibility/operators.md (22)
  • user-guide/latest/iceberg.md (17)
  • user-guide/latest/operators.md (9)
  • user-guide/latest/compatibility/floating-point.md (8)
  • user-guide/latest/compatibility/regex.md (8)
  • user-guide/latest/migration-guide.md (7)
  • user-guide/latest/compatibility/index.md (6)
  • user-guide/latest/datasources.md (6)
  • user-guide/latest/compatibility/expressions/_category_template/cast.md (5)
  • user-guide/latest/in-memory-cache.md (5)
  • user-guide/latest/compatibility/json.md (3)
  • user-guide/latest/datatypes.md (3)
  • user-guide/latest/installation.md (3)
  • user-guide/latest/rust_udfs.md (3)
  • user-guide/latest/compatibility/expressions/_category_template/datetime.md (2)
  • user-guide/latest/delta.md (2)
  • user-guide/latest/metrics.md (2)
  • user-guide/latest/parquet.md (2)
  • user-guide/latest/pyarrow-udfs.md (2)
  • user-guide/latest/tuning/operators.md (2)
  • user-guide/latest/tuning/shuffle.md (2)
  • user-guide/latest/compatibility/expressions/_category_template/map.md (1)
  • user-guide/latest/compatibility/expressions/index.md (1)
  • user-guide/latest/compatibility/expressions/spark-3.4/index.md (1)
  • user-guide/latest/compatibility/expressions/spark-3.5/index.md (1)
  • user-guide/latest/compatibility/expressions/spark-4.0/index.md (1)
  • user-guide/latest/compatibility/expressions/spark-4.1/index.md (1)
  • user-guide/latest/compatibility/expressions/spark-4.2/index.md (1)
  • user-guide/latest/kubernetes.md (1)
  • user-guide/latest/tuning.md (1)
  • user-guide/latest/tuning/transitions.md (1)

Contributor guide

  • contributor-guide/adding_a_new_operator.md (17)
  • contributor-guide/adding_a_new_expression.md (8)
  • contributor-guide/sql-file-tests.md (8)
  • contributor-guide/sql_error_propagation.md (5)
  • contributor-guide/roadmap.md (4)
  • contributor-guide/spark_configs_support.md (4)
  • contributor-guide/bug_triage.md (3)
  • contributor-guide/development.md (3)
  • contributor-guide/timezones.md (3)
  • contributor-guide/iceberg-writes.md (2)
  • contributor-guide/config_conventions.md (1)
  • contributor-guide/ffi.md (1)
  • contributor-guide/profiling.md (1)

About

  • about/versioning_policy.md (2)
  • about/faq.md (1)

AI assistance: OpenCode built this list from a search of main and the style guide.

Activity

  1. Abhishek-Mohan commented on Nov 9, 2026

    @Abhishek-Mohan
    ContributorAuthor

    take

  2. added 4 commits that reference this issue on Nov 9, 2026
    a1ca2e5
    71aca66
    c4d8c5c
    e53d370
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions