Skip to content

Docs: update documentation for PYNQ v4.0 - #1664

Open
unizhibin wants to merge 36 commits into
Xilinx:pynq-nextfrom
unizhibin:docu_fixed
Open

unizhibin wants to merge 36 commits into
Xilinx:pynq-nextfrom
unizhibin:docu_fixed

Conversation

@unizhibin

Copy link
Copy Markdown

This is my first contribution to PYNQ. It mostly fixes small things in the docs for v4.0, like typos, broken links, outdated commands and naming (PuTTY, CPython, PYNQ). I also updated the glossary and FAQs, added an unzip step to the Windows SD card instructions, fixed the Linux static IP section, and added Versal etc...

A few things I'm not fully sure about yet:

  • The Versal PS-PL parts. I haven't worked with Versal before, so please check those carefully. I'm still learning and may have some details wrong.
  • VCK190 details. For example, the board has 2 buttons, but Base.py uses 4. That's in the code, not the docs, so I haven't touched it here.

Happy to fix anything you spot.

Zhao added 30 commits October 5, 2026 10:23
Changed: 'or' -> 'and' in the value check (one line each in button.py and switch.py).

Not changed: everything else, including axigpio.py and the docs.

Why: the old check was true for every input, so even 0 and 1 were rejected.
- Jupyter password FAQ: use jupyter_server_config.py, c.PasswordIdentityProvider.hashed_password and jupyter_server.auth.passwd (argon2)

- Python FAQ: Ubuntu 24.04 image, Python 3.12, no Python 2.7

- Overlay bitstream FAQ: build.sh only builds the ZCU104 base overlay; use make in the overlay folder for others

- Proxy FAQ: use export instead of Windows-style set
Ubuntu 18.04 and later no longer use /etc/network/interfaces by default, so add NetworkManager and netplan steps and keep the old ifupdown steps for older systems.

Also fix "inet dynamic" (invalid) to "inet dhcp", use spaces instead of tabs in the last code block, and fix "Ip address" typo in the Windows steps.
Zhao added 6 commits October 8, 2026 16:41
manifests/ is created by pre.sh on the image, not in the source tree.
orchestrator.py only reads defaults.hardware, so defaults.timeout is ignored.

Signed-off-by: Zhao <zhizhao@amd.com>
@unizhibin
unizhibin changed the base branch from master to pynq-next October 9, 2026 11:03
@unizhibin unizhibin closed this Oct 9, 2026
@unizhibin

Copy link
Copy Markdown
Author

Closed with unmerged commits

@unizhibin unizhibin reopened this Oct 9, 2026

This branch has not been deployed

No deployments
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.

1 participant