AddonManager: Render different addon documents on a tabbed group

[hasecilu]

Works as expected but probably it's better to tweak a little the code. Are plans to update the package metadata format? Not sure if it really interesting to h ave the license.

Important

As of now documents URL are hardcoded, probably is better to only hardcode the package.xml URL and then from it parse all needed URLS, but as of now contributing or changelog are not in the specification.

• Hide when showing macros
• Heading with link is downgraded to text
• Emojis from changelog don't appear 😭 Is the font on FreeCAD not able to fallback when codepoint is not populated on current font?

GitHub	AM

---

Fix FreeCAD/AddonManager#5

[luzpaz]

An update to the https://wiki.freecad.org/Package_Metadata (package.xml) documentation will be required as well.

[hasecilu]

I was making some tests like adding URLs on the metadata (instancezero/in3dca-freegrid@63c0474) but would be really needed?

The URL of the README on the metadata is the blob one (html) which is not used by the Addon Manager to render, AM generates the raw URL containing markdown which is used. CONTRIBUTING and CHANGELOG are fairly standard files, license varies but at least we know the file.

Is there another file for which would be useful to show to users? I usually add a README file on the translations directory until now I only have put instructions there but maybe adding a table with progress for each language is informative.

[hasecilu]

I was thinking on extending the specification to contain the relative path of the document like:

<changelog>./CHANGELOG.md</changelog>
<contributing>CONTRIBUTING.md</contributing>

When we need raw or blob URL we can use the updated def construct_git_url(repo, doc: str, raw_file: bool = True) function that works with many git providers.

I don't like the README way because it directly assigns a branch on the URL:

  <url type="readme">https://github.com/instancezero/in3dca-freegrid/blob/main/README.md</url>

And when I add a custom URL for a testing branch, the AM still tries docs from main branch, but this is an edge case.

An alternative way would be to add entry like LICENSE. where file is specified

  <license file="LICENSE">AGPL-3.0-or-later</license>
  <changelog file="CHANGELOG.md"></changelog>
  <contributing file="CONTRIBUTING.md"></contributing>

augmenting metadata spec with this entries we can construct the needed URLs.

[hasecilu]

If added to spec...

[ovo-Tim]

Hi, since you changed construct_git_url, maybe you could have a look at this: #19242

[luzpaz]

We can open a tracking ticket on FreeCAD-Addons when this PR is merged.

[hasecilu]

Can the "Addon developers" group on on FreeCAD's GitHub org emit announcements?

[hasecilu]

Could work like that if images are included on the repo, otherwise we could use URLs to the images.

https://github.com/FreeCAD/FreeCAD/issues/13632

[hasecilu]

Created new tag
Tested adding testing branch to AM on settings -https://github.com/instancezero/in3dca-freegrid/tree/test/am_docs

  <doc type="readme">README.md</doc>
  <doc type="changelog">CHANGELOG.md</doc>
  <doc type="contributing">CONTRIBUTING.md</doc>

[github-actions]

Thanks for helping improve FreeCAD!
This pull request hasn’t seen activity in a while. We automatically check each PR after 120 days without activity to keep the repository tidy.

If the PR is still relevant, let us know by adding a comment.
Otherwise, we’ll close this PR automatically in 60 days.

If you would like to keep working on this pull request, we advice to rebase it on current main branch, ask feedback from users or maintainers and engage with the community to get it forward.