simplify readme #301
Comments
|
This makes sense! I think it could be good to still keep minimal info, but
we could move it to a separate .md file? I guess I like the idea that if
someone downloads this and is offline that they would have some basic info
to start. And great if you want to draft /pr!
…On Mon, May 27, 2024 at 9:12 AM Naoto Hieda ***@***.***> wrote:
perhaps it would make sense to simplify readme file and just point to
https://hydra.ojack.xyz/docs/
but maybe it's still better to keep minimal info so the readme is
standalone? what do you think, @ojack <https://github.com/ojack>, I can
also draft it
—
Reply to this email directly, view it on GitHub
<#301>, or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABFOVSII6FDVUKPWLQTOX53ZELMGLAVCNFSM6AAAAABIKTU2PKVHI2DSMVQWIX3LMV43ASLTON2WKOZSGMYTQNBRGM4DQOI>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
also can you check if the docs are up to date with the repo? The getting started link is broken and |
Draft
|
Right now it requires syncing and pushing to the repo at
https://github.com/hydra-synth/hydra-synth.github.io in order to update!
Would you want to try doing this? I have a really busy week but otherwise
can try on Thursday or Friday.
…On Mon, May 27, 2024, 17:35 Naoto Hieda ***@***.***> wrote:
also can you check if the docs are up to date with the repo? The getting
started link is broken and
***@***.***
<hydra-synth/hydra-docs-v2@1954b9f>
this commit is supposed to fix the link
—
Reply to this email directly, view it on GitHub
<#301 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABFOVSKQ3MDAU7JFTP2VWNDZENHD7AVCNFSM6AAAAABIKTU2PKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMZTG4YDSMBQGY>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
I see - so you are using package.json to bundle the submodules and publish to gh-pages branch? I don't think I can do it right now, but if I find time I will look into it if it's possible to automate the process through github actions :) The only problem with github actions that it has to be triggered by the submodules. It seems it is possible but seems a bit cumbersome. |
|
Yes, using github actions would be great!
…On Mon, May 27, 2024 at 9:50 PM Naoto Hieda ***@***.***> wrote:
I see - so you are using package.json to bundle the submodules and publish
to gh-pages branch? I don't think I can do it right now, but if I find time
I will look into it if it's possible to automate the process through github
actions :)
The only problem with github actions that it has to be triggered by the
submodules. It seems it is possible but seems a bit cumbersome.
https://thenewstack.io/how-to-trigger-github-actions-on-submodule-updates/
Even if we decide not to fully automate it, we can still manually trigger
github actions from the web interface
—
Reply to this email directly, view it on GitHub
<#301 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABFOVSL2UXRNDX7WBNCH7S3ZEOE7BAVCNFSM6AAAAABIKTU2PKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMZTHE4DMMBRGM>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
perhaps it would make sense to simplify readme file and just point to https://hydra.ojack.xyz/docs/
but maybe it's still better to keep minimal info so the readme is standalone? what do you think, @ojack, I can also draft it
The text was updated successfully, but these errors were encountered: