search

GSharker / G-Shark

G-Shark is a free and open-source geometry library designed for computational designers and software developers in the Architecture, Engineering, and Construction (AEC) industry.
https://gsharker.github.io/G-Shark/
MIT License
212 stars 36 forks source link

Updated the index.md #395

Closed cesarecaoduro closed 1 year ago

cesarecaoduro commented 1 year ago

Updated the index.md file for the documentation

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

Description

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

Related Tickets & Documents

No issues related

Added tests?

Added to documentation?

sonomirco commented 1 year ago

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 commented 1 year ago

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 iOShttps://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 GitHubhttps://github.com/GSharker/G-Shark/pull/395#issuecomment-1370319968, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AGJG6AYE5NHV4JPELZBB523WQSXHVANCNFSM6AAAAAATQFD6XM. You are receiving this because you were assigned.Message ID: @.***>

sonomirco commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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.