Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: slackapi/bolt-python
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: main
Choose a base ref
...
head repository: slackapi/bolt-python
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: md-reference
Choose a head ref
Checking mergeability… Don’t worry, you can still create the pull request.
  • 13 commits
  • 497 files changed
  • 2 contributors

Commits on Aug 13, 2026

  1. docs: add Markdown code fences to docstrings

    Wrap inline code examples in docstrings with ```python fences so the
    Markdown API reference renders them as highlighted code blocks instead of
    flat prose. Changes are docstring-only; no code behavior is affected.
    
    Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
    lukegalbraithrussell and Claude committed Aug 13, 2026
    Configuration menu
    Copy the full SHA
    01015a2 View commit details
    Browse the repository at this point in the history
  2. docs: migrate API reference from HTML (pdoc3) to Markdown (pydoc-mark…

    …down)
    
    Replace the pdoc3 HTML generator with pydoc-markdown so the API reference
    is emitted as Markdown for docs.slack.dev/Docusaurus.
    
    - Rewrite generate_api_docs.sh to drive the new Markdown pipeline.
    - Add generate_api_docs.py, which:
      - inlines re-exported classes/functions so adapter pages show their
        handler inline (matching pdoc3's behavior);
      - adds OrderedGoogleProcessor to keep fenced code blocks in their
        original position (the stock GoogleProcessor relocates a code block
        that precedes a section keyword to after the prose);
      - replaces pydoc-markdown's escape_except_blockquotes, which corrupts
        docstrings with >10 code spans by duplicating a code block into later
        spans (BLOCKQUOTE_TOKEN prefix collision).
    - Regenerate docs/reference as Markdown (removes the old HTML tree).
    - Point the sidebar "Reference" link at the new Markdown path.
    
    Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
    lukegalbraithrussell and Claude committed Aug 13, 2026
    Configuration menu
    Copy the full SHA
    67812bc View commit details
    Browse the repository at this point in the history
  3. docs: serve package reference pages at folder URLs

    Rename each generated package __init__.md to index.md and rewrite the
    generated sidebar.json edges to match. The docusaurus renderer emits a
    package's docs as <pkg>/__init__.md, whose route is .../<pkg>/__init__ --
    nothing resolves at the bare .../<pkg>/ URL that the sidebar's Reference
    link (.../reference/slack_bolt/) targets. Docusaurus serves index.md at
    the folder URL, so this makes that link resolve instead of 404.
    
    Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
    lukegalbraithrussell and Claude committed Aug 13, 2026
    Configuration menu
    Copy the full SHA
    2266bf2 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    23874b0 View commit details
    Browse the repository at this point in the history
  5. docs: fence App.start() example and target docs/english/reference

    The App.start() docstring had an indented (unfenced) code example whose
    '#' comment lines rendered as Markdown H1 headers in the Markdown output.
    Wrap it in a ```python fence. This propagates to all 24 pages that inline
    App via re-export.
    
    Also point the generator at docs/english/reference (the reference tree's
    location) instead of docs/reference.
    
    Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
    lukegalbraithrussell and Claude committed Aug 13, 2026
    Configuration menu
    Copy the full SHA
    de6d47e View commit details
    Browse the repository at this point in the history
  6. docs: embed reference tree into _sidebar.json

    The docs site imports docs/english/_sidebar.json and filters it; it does
    not read the generated reference/sidebar.json. Replace the external
    "Reference" link with the generated category tree, prefixing doc IDs with
    tools/bolt-python/ so they resolve against the docs root.
    
    The generator now does this automatically (_sync_reference_sidebar) so the
    sidebar stays in sync on every regeneration.
    
    Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
    lukegalbraithrussell and Claude committed Aug 13, 2026
    Configuration menu
    Copy the full SHA
    51128e2 View commit details
    Browse the repository at this point in the history

Commits on Aug 14, 2026

  1. go

    lukegalbraithrussell committed Aug 14, 2026
    Configuration menu
    Copy the full SHA
    c6960fc View commit details
    Browse the repository at this point in the history
  2. go

    lukegalbraithrussell committed Aug 14, 2026
    Configuration menu
    Copy the full SHA
    2b95612 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    44bafeb View commit details
    Browse the repository at this point in the history
  4. go

    lukegalbraithrussell committed Aug 14, 2026
    Configuration menu
    Copy the full SHA
    da71715 View commit details
    Browse the repository at this point in the history
  5. go

    lukegalbraithrussell committed Aug 14, 2026
    Configuration menu
    Copy the full SHA
    7bf50da View commit details
    Browse the repository at this point in the history
  6. go

    lukegalbraithrussell committed Aug 14, 2026
    Configuration menu
    Copy the full SHA
    ab7e690 View commit details
    Browse the repository at this point in the history
  7. go

    lukegalbraithrussell committed Aug 14, 2026
    Configuration menu
    Copy the full SHA
    24fe29c View commit details
    Browse the repository at this point in the history
Loading