T1L and SPOE boards

[aronkis]

Type

• Documentation
• Bug fix
• New feature
• Continuous integration

Checklist

• I have performed a self-review of changes
• I have followed the guidelines:
  • https://analogdevicesinc.github.io/documentation/contributing/docs_guidelines.html
  • https://analogdevicesinc.github.io/doctools/docs_guidelines/index.html
  • https://analogdevicesinc.github.io/documentation/contributing/creating_new_pages.html#documentation-structure
• I have used the appropriate roles and directives:
  • https://analogdevicesinc.github.io/doctools/docs_guidelines/roles.html
  • https://analogdevicesinc.github.io/doctools/docs_guidelines/directives.html
• I ensured that binary data was committed to git lfs:
  • https://analogdevicesinc.github.io/documentation/contributing/creating_new_pages.html#adding-images-and-other-binary-files
• I have built the pages I edited or created, using either make html or adoc serve:
  • https://analogdevicesinc.github.io/doctools/cli.html#serve
• I have signed-off my commits and believe my contribution improves the repository.

[gastmaier]

Hi aron, please renormalize your branch to use git lfs, this ensures it is snappy for everyone in the longterm
https://analogdevicesinc.github.io/documentation/contributing/creating_new_pages.html#adding-images-and-other-binary-files
https://analogdevicesinc.github.io/documentation/contributing/forking_publishing.html#files-that-should-have-been-pointers
thanks

[gastmaier]

I cannot add @aronkis as a contributor of the repo. Do you have your SSO correlated with that account?

[aronkis]

@gastmaier SSO is now correlated with this account.

[jvelasc2]

Hi @gastmaier ,
Would it be possible to get these pages prioritized among the ongoing PRs? These models are up for release on analog.com; the other pages we raised were just Wiki to Git migration of already released boards.

Thank you for your help!

Regards,
Joyce

[gastmaier]

Hi, please don't generate merge commits like this. It is ok to do once or twice if it is intentional (e.g. create a merge commit with another branch with the intent of showing it as interdependent). I ended up raw checking out the head commit and recreating the commits since rebasing on main was impossible...
you can keep your branch behind main, and it is better to "update" with git rebase origin/main instead of merging, since you don't post-pone to the reviewer the conflicts.

I suppose the actual edit files are under:

ad-apard32690-sl (existing files modifications)
ad-apardpfwd-sl
ad-apardspoe-sl
ad-rpi-t1lpse-sl
ad4130-pmod

After the head checkout and initial commits, claude helped me, using the prompts:

 I am trying to rebase/review/re-organize some commits made by another developer, it is documentation commits. the range is from
6b47dc8521c882d22e5b89c1dd3010ebb3399308~..ca58e6dda64120e9d6542a9bf86baa3bbc2db1f8 . Learn the repository format, by reading
docs/contributing/docs_guidelines.rst , /mnt/wsl/data/repos/doctools/docs/docs_guidelines/index.rst ,
/mnt/wsl/data/repos/doctools/docs/docs_guidelines/directives.rst and /mnt/wsl/data/repos/doctools/docs/docs_guidelines/roles.rst . Fix trailing
whitespace. A live build runs on http://0.0.0.0:8001 , a virtual environment is enabled with Sphinx. Feel free to install
auxiliary pip packages to help you see. Use --fixup commits for each commit, at the end I would like to one commit for each project

Then

Now, the live server is shutdown, because I want you to do `make clean html` in the docs folder and fix all warnigns, also using --fixup commits to
the project commits

then I went back to each commit and reviewed.

Then

We are doing great! Now let's rework these commits messages. We are going to commit on behalf of 
`Signed-off-by: Aron Kis <kis.aron@analog.com>` (the original author)
The commit range is 
55427a3c89aa7498f8d25fa6665c1b8485eacdbb~..741eb6f7d20c7f34bf157c3c698a78684d99e85e

A good template for a commit message is (but wrapping the lines as an usual git commit):

```
solutions/ad-swiot1l-sl: Modify user guide

Update the structure of the software user guide by deleting unnecessary hardware setup section and adding a system setup section
Add a getting started section to the general user guide that redirects the user to quickstart guides related to the usage of the board with Scopy and developing application or firmware code
Add an image with the SWIOT1L kit that was present on the Wiki page, but not in the Github documentation
```

Then compare the changes with you head.
Your previous head commit is f8aa24a

[gastmaier]

Please, now do a self-review of the changes. Especially added links that does not exist.
Further commits should be created with

git commit --fixup <SHA_OF_THE_COMMIT_FIXING>

[gastmaier]

Force pushed to --autosquash the --fixup commits

[gastmaier]

Please, focus on providing valid links to the source code.
Blind testing, I quickly found one that is broken

[gastmaier]

So, this does not exist in the no-OS main branch, cannot find a branch that relates to this and the upper case path is very suspicious, am I missing something?

[aronkis]

This one is missing, I'm currently working on a PR to add this project to NO-OS. You can see it here. I will have to change the path today, so it will be <projects/apardpfwd>. This link was meant only as a placeholder.

[aronkis]

Changed the apardpfwd to the correcet path.
Added additional information to the AD-RPI-T1LPSE-SL for building the Kuiper image.