(doc) Documentation standards

[cvvergara]

Standard on labels

Use:

• official-start and official-end
• proposed-start and proposed-end
• experimental-start and experimental-end
• warning-start and warning-end

Example

.. official-start
<documentation>
.. official-end

Availability and release notes

• Use less bold & code markers

Example:
pgr_aStar (One to One) -> pgr_aStar(One to One)

Boost information

Make it smaller and the last thing before the signatures

Example:
Before

with this PR

The link original link to boost is placed on the See also section.

Links from index

Place the index command before the | so when jumping from the index page the title can be seen completly.

.. index:: Via Category

|

Sentence about sampledata

Use on the See also section:

* doc:`sampledata`

Instead of different sentences about using the sample data on the examples.

@pgRouting/admins

Summary by CodeRabbit

Based on the comprehensive summary of changes, here are the high-level release notes for end-users:

Release Notes

• Documentation Improvements

  • Standardized documentation formatting across all function references
  • Updated index entries and section markers for clarity
  • Enhanced visibility of function signatures
  • Improved references to Boost Graph Library

• Function Status Updates

  • Several functions promoted to proposed or official status
  • Clarified experimental and proposed function categories
  • Updated availability notes for multiple functions

• Signature Changes

  • Removed backticks from function signatures
  • Updated parameter descriptions
  • Added/modified result columns for various functions

• Experimental Features

  • Marked new functions with experimental status
  • Provided clearer descriptions of experimental functionality
  • Added warnings and notes about experimental features

• Boost Graph Library Integration

  • Added references to Boost Graph documentation
  • Enhanced context for algorithm implementations

• Miscellaneous Improvements

  • Minor grammatical and formatting corrections
  • Streamlined documentation structure
  • Improved clarity of function descriptions

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces comprehensive documentation updates across the pgRouting project. The changes primarily focus on standardizing documentation formatting, updating function statuses (proposed, experimental, official), and improving clarity in function descriptions. Key modifications include removing backticks from function names, updating warning section markers, clarifying function signatures, and adding references to the Boost Graph library. The updates span multiple documentation files, ensuring consistent presentation and enhanced readability without altering core functionality.

Changes

File/Category	Change Summary
Documentation Formatting	Removed backticks from function names
Warning Markers	Updated from begin-warn-expr to warning-begin
Function Status	Clarified proposed, experimental, and official statuses
Boost References	Added consistent references to Boost Graph library
Index Entries	Updated to include function status (Proposed, Experimental)

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Docs as Documentation
    participant Markers as Section Markers
    participant Boost as Boost Reference

    Dev->>Docs: Update documentation
    Docs->>Markers: Replace old markers
    Markers->>Docs: Update section start/end
    Dev->>Docs: Clarify function status
    Dev->>Docs: Remove backticks
    Dev->>Boost: Add library references
    Boost->>Docs: Include references

Loading

Poem

🐰 A Rabbit's Documentation Dance 🌈

With backticks gone and markers bright,
Our docs now shine with clarity's light
Boost graphs whisper, functions gleam
Proposed and official, a coder's dream!
pgRouting's manual, crisp and clear 📘

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.