Skip to content

chore: reusing slim sdk docs - #2005

Open
keraron wants to merge 7 commits into
mainfrom
docs-slim-sdk
Open

keraron wants to merge 7 commits into
mainfrom
docs-slim-sdk

Conversation

@keraron

@keraron keraron commented Aug 25, 2026

Copy link
Copy Markdown
Member

Description

Fixes #1892

Together with slim-bindings PR #77, this PR moves the SDK docs to the slim-bindings repo and reuses the content from there when building the documentation.

Type of Change

  • Bugfix
  • New Feature
  • Breaking Change
  • Refactor
  • Documentation
  • Other (please describe)

Checklist

  • I have read the contributing guidelines
  • Existing issues have been referenced (where applicable)
  • I have verified this change is not present in other open pull requests
  • Functionality is documented
  • All code style checks pass
  • New code contribution is covered by automated tests
  • All new and existing tests pass

@keraron
keraron marked this pull request as ready for review September 17, 2026 12:07
@keraron
keraron requested a review from a team as a code owner September 17, 2026 12:07

@muscariello muscariello left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Tehsmash Tehsmash left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a couple issues with this PR. The original docs pre-2.0.0 did include the docs like this but there are a few issues with that so I removed it and inlined the docs.

First this change makes the docs track SDK documentation from slim-bindings main. This results in unreleased doc changes going out.

Related to this structure of the docs is defined in this repo so if we want to change that we have an issue because we can't merge changes to main docs in slim-bindings to move to the new structure without breaking the existing docs.

I would ask what we're gaining from this change, we're introducing a weird dependency cycle, today the docs are monorepoed here but they are versioned/released separately.

If we want to do this "split" properly then I think we need to use either split the docs out of SLIM into a separate slim-docs repo to make the separate versioning obvious.
OR
We should use GitHub actions to have slim-bindings publish it's pages into the slim/gh-pages branch itself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore(docs): document .NET bindings

3 participants