Skip to content

Add GitHub Pages documentation #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 11, 2025
Merged

Add GitHub Pages documentation #210

merged 1 commit into from
Sep 11, 2025

Conversation

romandariana
Copy link
Contributor

@romandariana romandariana commented Aug 27, 2025 •
edited
Loading

Pull Request Description

Check out the result on my fork: https://romandariana.github.io/adi-kuiper-gen/ :D

Add docs folder with all needed source files for GitHub Pages documentation.

Add .github/workflows/top-level.yml to setup the GitHub Pages deployment workflow.

Move the complete documentation from README.md to GitHub Pages. Now README.md contains a succinct introduction and references the comprehensive documentation.

PR Type

  • New feature (change that adds new functionality)

PR Checklist

  • I have performed a self-review of the changes
  • I have signed off all commits from this PR
  • I have updated the documentation (wiki pages, ReadMe etc)

@SRaus SRaus requested a review from NicuS03 August 27, 2025 07:35
@romandariana romandariana self-assigned this Aug 27, 2025
@romandariana romandariana added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 27, 2025
@romandariana
Copy link
Contributor Author

v1 -> v2:
Applied some doc fixes suggested by @gastmaier (thank you!)
- Use code-block instead of shell
- Drop rst2pdf
- Use git role syntax for arbitrary links
- Remove unused interref

gastmaier
gastmaier previously approved these changes Aug 27, 2025
View reviewed changes
Copy link

@gastmaier gastmaier left a comment

Choose a reason for hiding this comment

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

Thank you :)

NicuS03
NicuS03 previously approved these changes Aug 28, 2025
View reviewed changes
@ioanachelaru ioanachelaru self-requested a review August 29, 2025 12:19
@romandariana romandariana dismissed stale reviews from NicuS03 and gastmaier via df9cdc1 September 1, 2025 14:48
@romandariana
Copy link
Contributor Author

v2 -> v3:
Added this page: https://romandariana.github.io/adi-kuiper-gen/hardware-configuration.html, documenting #211. The exact changes can be checked by viewing this commit on my fork: romandariana@ab1349a. Here I squashed this commit together with the other changes.

gastmaier
gastmaier previously approved these changes Sep 3, 2025
View reviewed changes
gastmaier
gastmaier reviewed Sep 8, 2025
View reviewed changes
github-actions bot added a commit that referenced this pull request Sep 8, 2025
@github-actions
deploy: 393f06a #210 (synchronize)
b177ca6
@romandariana
Copy link
Contributor Author

romandariana commented Sep 8, 2025 •
edited
Loading

v3 -> v4:
- updated the workflows as recommended by @gastmaier (thank you!). also changed the name
- typo: zedboard -> zed (hardware-configuration.rst)
- Using Generated Image -> Using Kuiper Images
- explicitly mention the 2 flows for obtaining kuiper image

Exact changes here: romandariana@1ec7fda. Here I squashed this commit together with the other changes.

gastmaier
gastmaier previously approved these changes Sep 8, 2025
View reviewed changes
Copy link

@gastmaier gastmaier left a comment

Choose a reason for hiding this comment

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

Still approved on my side
Now with auto hosted pull request version https://analogdevicesinc.github.io/adi-kuiper-gen/pull/210/

SRaus
SRaus reviewed Sep 8, 2025
View reviewed changes
Copy link
Collaborator

@SRaus SRaus left a comment

Choose a reason for hiding this comment

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

I've let some suggestions - they are not required / implement what you consider.

mlradu
mlradu previously approved these changes Sep 9, 2025
View reviewed changes
@romandariana romandariana dismissed stale reviews from mlradu and gastmaier via f7b9c54 September 10, 2025 09:25
github-actions bot added a commit that referenced this pull request Sep 10, 2025
@github-actions
deploy: a8dd006 #210 (synchronize)
e911446
@romandariana
Copy link
Contributor Author

v4 -> v5:
- implemented all suggestions (@SRaus) I marked as resolved (thank you!)
- updated Repositories page according to how the packets are structured now
- tried to respect the max 80 characters per line rule wherever it didn't ruin the format of the page

Exact changes: romandariana@0e23a38. Result: https://analogdevicesinc.github.io/adi-kuiper-gen/pull/210/

@romandariana romandariana mentioned this pull request Sep 10, 2025
Merged
github-actions bot added a commit that referenced this pull request Sep 10, 2025
@github-actions
deploy: 3bbd1d1 #210 (synchronize)
7e1d798
github-actions bot added a commit that referenced this pull request Sep 10, 2025
@github-actions
deploy: 0e14d2c #210 (synchronize)
250b77d
@romandariana
Copy link
Contributor Author

v5 -> v6:
- hardware-configuration.rst: improvements; add manual configuration steps
Exact changes: romandariana@0a85378. Result: https://analogdevicesinc.github.io/adi-kuiper-gen/pull/210/.

@mlradu mlradu self-requested a review September 11, 2025 09:31
mlradu
mlradu previously approved these changes Sep 11, 2025
View reviewed changes
github-actions bot added a commit that referenced this pull request Sep 11, 2025
@github-actions
deploy: a5e6c73 #210 (synchronize)
ff9963c
github-actions bot added a commit that referenced this pull request Sep 11, 2025
@github-actions
deploy: ec1ee77 #210 (synchronize)
e0b0d35
github-actions bot added a commit that referenced this pull request Sep 11, 2025
@github-actions
deploy: a8b27e9 #210 (synchronize)
d8035e8
@romandariana romandariana force-pushed the dev_docs branch 2 times, most recently from fea9d2e to 3269450 Compare September 11, 2025 14:52
github-actions bot added a commit that referenced this pull request Sep 11, 2025
@github-actions
deploy: 0c1ffad #210 (synchronize)
2a60425
github-actions bot added a commit that referenced this pull request Sep 11, 2025
@github-actions
deploy: 8bdea7b #210 (synchronize)
fd3859f
@romandariana
Add GitHub Pages documentation
9328790 
Add docs folder with all needed source files for GitHub Pages
documentation.

Add .github/workflows/gh-pages.yml and .github/workflows/pr-closed.yml
to setup the GitHub Pages deployment workflow.

Move the complete documentation from README.md to GitHub Pages. Now
README.md contains a succinct introduction and references the
comprehensive documentation.

Signed-off-by: Alisa-Dariana Roman <[email protected]>
github-actions bot added a commit that referenced this pull request Sep 11, 2025
@github-actions
deploy: 3997dcd #210 (synchronize)
9df9e04
@mlradu mlradu self-requested a review September 11, 2025 15:10
@romandariana romandariana merged commit 2d6a255 into main Sep 11, 2025
6 checks passed
@romandariana romandariana deleted the dev_docs branch September 11, 2025 15:11
github-actions bot added a commit that referenced this pull request Sep 11, 2025
@github-actions
deploy: 2d6a255 #210 (closed)
8382799
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gastmaier gastmaier gastmaier left review comments

@SRaus SRaus SRaus left review comments

@mlradu mlradu mlradu approved these changes

@NicuS03 NicuS03 NicuS03 left review comments

@dbogdan dbogdan Awaiting requested review from dbogdan dbogdan is a code owner

@ioanachelaru ioanachelaru Awaiting requested review from ioanachelaru

Assignees

@romandariana romandariana

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@romandariana @gastmaier @SRaus @mlradu @NicuS03