Updated the index.md

[cesarecaoduro]

Updated the index.md file for the documentation

What type of PR is this? (check all applicable)

• ♻️ Refactor
• ✨ Feature
• 🐛 Bug Fix
• 👷 Optimization
• 📝 Documentation Update
• 🔖 Release
• 🚩 Other

Description

This PR updates the index.md file generated with the documentation

Related Tickets & Documents

No issues related

Added tests?

• 👍 yes
• 🙅 no, because they aren't needed
• 🙋 no, because I need help

Added to documentation?

• 📓 docs
• 🙅 no documentation needed

[sonomirco]

Can we have the logo on the index page?
How do we want to treat these kinds of changes in terms of release/NuGet package?
Currently, if we merge this PR a new NuGet will be generated, is it worth having a new package for changes like this?

[cesarecaoduro]

I don’t think that this is worth a release. We have to find a mechanism to release only on version tags, or we have to split the documentation on a separate branch, potentially a separate repository. Sent from Outlook for iOS<https://aka.ms/o0ukef>

…

________________________________ From: Mirco Bianchini ***@***.***> Sent: Wednesday, January 4, 2023 10:15:06 AM To: GSharker/G-Shark ***@***.***> Cc: Cesare Caoduro ***@***.***>; Assign ***@***.***> Subject: Re: [GSharker/G-Shark] Updated the index.md (PR #395) Can we have the logo on the index page? How do we want to treat these kinds of changes in terms of release/NuGet package? Currently, if we merge this PR a new NuGet will be generated, is it worth having a new package for changes like this? — Reply to this email directly, view it on GitHub<#395 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AGJG6AYE5NHV4JPELZBB523WQSXHVANCNFSM6AAAAAATQFD6XM>. You are receiving this because you were assigned.Message ID: ***@***.***>

[sonomirco]

The release action generates the tag.
An implementation is that only PRs with labels Major or Minor creates a NuGet package; all the others add a new release in GitHub.

[cesarecaoduro]

The release action generates the tag. An implementation is that only PRs with labels Major or Minor creates a NuGet package; all the others add a new release in GitHub.

We have to put some more thoughts around this. For now we can merge this small update.
Also considering the logo, we already have the logo on the sidebar, I don't think there is a need of another logo in the main content.
We probably need to also spend some time styling the template, but it is not a priority (I will Open an issue for this)

[d3ssy]

Weren't the docs being generated from gshark/docs branch? I don't think users should have to touch the doc generation or need to download it with the main branch.

[sonomirco]

That is the brunch used to publish the doc, but the documentation is on the main repo, but I don't think is a problem.