Skip to content

Commit e675402

Browse files
docs: refactor and organise SDK documentation (#2106)
Signed-off-by: DeathGun44 <krishnamewara841@gmail.com> Co-authored-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
1 parent 1c4eb50 commit e675402

28 files changed

Lines changed: 28 additions & 3392 deletions

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
2121

2222
### Docs
2323

24+
- docs: Refactor and organise SDK documentation; delete obsolete directories (`community-calls`, `github`, `workflows`, `maintainers`, `sdk_developers/automations`) and generic guides (`signing.md`, `rebasing.md`, `merge_conflicts.md`, `changelog_entry.md`) now maintained in the upstream `sdk-collaboration-hub`; relocate `team.md` to `docs/team.md`; redirect all affected inbound links in `README.md`, `CONTRIBUTING.md`, and internal developer docs to upstream equivalents (#2101)
2425

2526
### .github
2627
- Renamed community call and office hour bots to use the `cron-` prefix (#2068)

CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ Thank you for your interest in contributing to the Hiero Python SDK!
3838
**Detailed Docs:**
3939

4040
- [Setup Guide](docs/sdk_developers/setup.md)
41-
- [Signing Guide](docs/sdk_developers/signing.md)
42-
- [Changelog Guide](docs/sdk_developers/changelog_entry.md)
43-
- [Rebasing Guide](docs/sdk_developers/rebasing.md)
44-
- [Merge Conflicts Guide](docs/sdk_developers/merge_conflicts.md)
41+
- [Signing Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/signing.md)
42+
- [Changelog Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/changelog-guide.md)
43+
- [Rebasing Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/rebasing.md)
44+
- [Merge Conflicts Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/merge_conflicts.md)
4545
- [Testing Guide](docs/sdk_developers/testing.md)
4646

4747

@@ -103,11 +103,11 @@ We welcome blog posts! Whether you're sharing a tutorial, case study, or your ex
103103
|-------|----------------|
104104
| [Setup](docs/sdk_developers/setup.md) | Fork, clone, install, configure |
105105
| [Workflow](docs/sdk_developers/workflow.md) | Branching, committing, PRs |
106-
| [Signing](docs/sdk_developers/signing.md) | GPG + DCO commit signing |
107-
| [Changelog](docs/sdk_developers/changelog_entry.md) | Writing changelog entries |
106+
| [Signing](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/signing.md) | GPG + DCO commit signing |
107+
| [Changelog](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/changelog-guide.md) | Writing changelog entries |
108108
| [Checklist](docs/sdk_developers/checklist.md) | Pre-submission checklist |
109-
| [Rebasing](docs/sdk_developers/rebasing.md) | Keeping branch updated |
110-
| [Merge Conflicts](docs/sdk_developers/merge_conflicts.md) | Resolving conflicts |
109+
| [Rebasing](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/rebasing.md) | Keeping branch updated |
110+
| [Merge Conflicts](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/merge_conflicts.md) | Resolving conflicts |
111111
| [Types](docs/sdk_developers/types.md) | Python type hints |
112112
| [Linting](docs/sdk_developers/linting.md) | Code quality tools |
113113

@@ -158,7 +158,7 @@ git checkout your-branch
158158
git rebase main -S
159159
```
160160

161-
**Full guide:** [Rebasing Guide](docs/sdk_developers/rebasing.md)
161+
**Full guide:** [Rebasing Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/rebasing.md)
162162

163163

164164
---

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ print(f"Balance: {balance.hbars} HBAR")
6868
- **[Setup Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/setup.md)** - First-time environment setup
6969
- **[Windows Setup Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/setup_windows.md)** - Step-by-step guide for Windows users
7070
- **[Workflow Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/workflow.md)** - Day-to-day development workflow
71-
- **[Signing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/signing.md)** - GPG and DCO commit signing (required)
72-
- **[Changelog Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/changelog_entry.md)** - How to write changelog entries
73-
- **[Rebasing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/rebasing.md)** - Keep your branch up-to-date
74-
- **[Merge Conflicts Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/merge_conflicts.md)** - Resolve conflicts
71+
- **[Signing Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/signing.md)** - GPG and DCO commit signing (required)
72+
- **[Changelog Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/changelog-guide.md)** - How to write changelog entries
73+
- **[Rebasing Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/rebasing.md)** - Keep your branch up-to-date
74+
- **[Merge Conflicts Guide](https://github.com/hiero-ledger/sdk-collaboration-hub/blob/main/guides/issue-progression/for-developers/merge_conflicts.md)** - Resolve conflicts
7575
- **[Typing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/types.md)** - Python type hints
7676
- **[Linting Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/linting.md)** - Code quality tools
7777

docs/community-calls/18-02-25.md

Lines changed: 0 additions & 89 deletions
This file was deleted.

0 commit comments

Comments
 (0)