Skip to content

Fix README FAQ: correct releases URL and fix list rendering#186

Merged
jczaja merged 2 commits intomainfrom
copilot/fix-readme-releases-and-formatting
Mar 22, 2026
Merged

Fix README FAQ: correct releases URL and fix list rendering#186
jczaja merged 2 commits intomainfrom
copilot/fix-readme-releases-and-formatting

Conversation

Copy link
Contributor

Copilot AI commented Mar 22, 2026

FAQ section had a broken releases link pointing to the old repo (jczaja/e-trade-tax-return-pl-helper) and multiple FAQ items (§1, §3, §6) rendered as code blocks instead of lists due to 4-space indentation.

Changes

  • Releases link: jczaja/e-trade-tax-return-pl-helper/releasesRustInFinance/etradeTaxReturnHelper/releases
  • FAQ list formatting: Removed 4-space indentation from numbered/bullet list items in §1, §3, §6 — GitHub Markdown treats 4-space-indented content as a code block
  • Typo: priviligiesprivileges
Original prompt

Popraw wyświetlanie README.md w repozytorium RustInFinance/etradeTaxReturnHelper (branch bazowy: main).

Kontekst

  • W sekcji FAQ, punkt 1. How to install this project? pierwsza pod-pozycja ma odwołanie do releases, które jest „uszkodzone”/źle wyświetla się w renderowaniu.
  • Aktualnie w README.md link do releases wskazuje na inne repo: https://github.com/jczaja/e-trade-tax-return-pl-helper/releases.
  • Formatowanie list w FAQ wygląda na problematyczne (mieszanie nagłówków ##### z wcięciami i numerowaną listą może powodować złe renderowanie na GitHub).

Zadanie

  1. Napraw link do releases w FAQ, aby wskazywał poprawne releases dla tego repozytorium: RustInFinance/etradeTaxReturnHelper (np. https://github.com/RustInFinance/etradeTaxReturnHelper/releases).
  2. Popraw formatowanie sekcji FAQ tak, aby:
    • pierwszy punkt nie był „zepsuty” wizualnie,
    • listy (zagnieżdżone) renderowały się poprawnie w GitHub Markdown,
    • zachować sens treści i nie usuwać informacji.
  3. Upewnij się, że anchor/link do FAQ ([faq](#faq)) nadal działa.
  4. Zrób minimalne zmiany (tylko tyle, ile trzeba) i otwórz Pull Request na main.

Plik do zmiany

  • README.md

Referencja (aktualna wersja)

Kryteria akceptacji

  • Link „releases” w FAQ pkt 1 prowadzi do releases RustInFinance/etradeTaxReturnHelper.
  • Sekcja FAQ renderuje się poprawnie (nagłówki i listy bez błędnych wcięć).
  • PR jest otwarty przeciwko main i zawiera opis zmian.

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: popraw w moim repozytorium etradeTaxReturnHelper plik Readme bo mi sie zle wyswietla np. sekcja FAQ pierwszy punkt jak jest odwolanie do releases to jest uszkodzone

Assistant: Czekam na Twoją akceptację/odrzucenie zmian w oknie dialogowym — jak tylko potwierdzisz, będę mógł kontynuować i dokończyć poprawkę README (w tym naprawę linku do “releases” w FAQ, pkt 1).

User: wystaw PR

Assistant: Nie mogę jeszcze wystawić PR, bo nie podałeś pełnej nazwy repozytorium w formacie owner/repo (a nie mogę jej domyślać).

Podaj proszę dokładnie, gdzie mam otworzyć PR:

  1. Czy to jest RustInFinance/etradeTaxReturnHelper (to repo otworzyłem z linku), czy Twoje forkowane repo jczaja/etradeTaxReturnHelper (albo inne)?
  2. Na jaką gałąź bazową mam celować — main?

Jak potwierdzisz owner/repo + branch, wystawię PR z poprawką (naprawa linku “releases” w FAQ pkt 1 oraz poprawa formatowania listy w tej sekcji, żeby nie „rozjeżdżało się” w renderowaniu).

User: RustInFinance/etradeTaxReturnHelper. celuj na main

Assistant: Czekam na Twoją akceptację w wyświetlonym oknie, żeby móc rozpocząć automatyczne przygotowanie zmian i otworzyć PR do RustInFinance/etradeTaxReturnHelper na gałąź main.

This pull request was created from Copilot chat.


💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

Copilot AI changed the title [WIP] Fix README.md links and formatting issues Fix README FAQ: correct releases URL and fix list rendering Mar 22, 2026
Copilot AI requested a review from jczaja March 22, 2026 09:52
@jczaja jczaja marked this pull request as ready for review March 22, 2026 10:09
@jczaja jczaja merged commit 3d1f4f3 into main Mar 22, 2026
8 checks passed
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.

2 participants