Updated readme.md + markdown #48
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request adds a comprehensive Table of Contents to the README, removes duplicate entries from the DTO table, updates code examples to use new DTO fields, documents DTO field updates in the CHANGELOG, and removes an unused GitHub workflow file.
- Added Table of Contents with 60+ links for improved navigation
- Updated documentation and examples to reflect new structured address fields (street_name, house_number, address_addition)
- Cleaned up duplicate DTO table entries (BankAccountDTO, FileDTO)
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Added comprehensive Table of Contents, removed duplicate DTO entries, updated examples to use new structured address fields, and added CHANGELOG reference for DTO updates |
| CHANGELOG.md | Documented new DTO fields added for contacts, additional addresses, bank accounts, and calendar years |
| .github/workflows/release.yml | Deleted unused release workflow file |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - [What is Bexio?](#-what-is-bexio) | ||
| - [Requirements](#-requirements) | ||
| - [Authentication](#authentication) |
There was a problem hiding this comment.
The Table of Contents link for 'Authentication' points to #authentication, but this section appears to be titled '## Authentication' (line 85). Based on the pattern where other TOC entries link to sections with emoji prefixes (e.g., '💡 What is Bexio?', '🔐 Authentication Setup'), this link may not work correctly if the actual section title uses an emoji prefix. Please verify the section heading matches this anchor.
| - [Authentication](#authentication) | |
| - [Authentication](#-authentication) |
|
|
||
| The following DTOs have been updated with new fields: | ||
|
|
||
| #### Contact & Additional Address Fields (2025-06-04) |
There was a problem hiding this comment.
The date '2025-06-04' appears to be in the future (June 2025), but we are currently in November 2025. This should likely be a past date or the current year. Please verify and correct the date to accurately reflect when these fields were added.
| - **AdditionalAddressDTO** and **CreateEditAdditionalAddressDTO**: Added `street_name`, `house_number`, and `address_addition` fields | ||
| - The `address` field is now deprecated in favor of the new structured address fields | ||
|
|
||
| #### Bank Account Fields (2025-06-06) |
There was a problem hiding this comment.
The date '2025-06-06' appears to be in the future relative to the previous entry (2025-06-04) and earlier than the current date (November 2025). While chronologically this makes sense if changes were made in June, please verify this is the intended date format and that all dates accurately reflect when features were added.
| - **BankAccountDTO**: Added `owner_house_number` and `owner_country_code` fields | ||
| - These fields provide more detailed owner information for bank accounts | ||
|
|
||
| #### Calendar Year Fields (2025-08-04) |
There was a problem hiding this comment.
The date '2025-08-04' appears to be in August 2025, which is in the past relative to November 2025. However, please verify this date is correct and consistent with when this feature was actually added to ensure accurate changelog documentation.
| #### Calendar Year Fields (2025-08-04) | |
| #### Calendar Year Fields (2025-11-04) |
No description provided.