-
-
Notifications
You must be signed in to change notification settings - Fork 899
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Bridge package docs: flame_fire_atlas
#1962
Comments
Hi, would like to work on this! |
Great! I've assigned you to the issue, don't forget to join our Discord if you have any questions etc. :) |
Is this still available? I can work on that! |
Hi @basil08, any progress on this? If you don't plan to do this please let us know so that we can open up this issue for other people. :) |
Yes, please unassign me. I am busy rn. Sorry for the delay.
…On Thu, Oct 13, 2022, 19:16 Lukas Klingsbo ***@***.***> wrote:
Hi @basil08 <https://github.com/basil08>, any progress on this? If you
don't plan to do this please let us know so that we can open up this issue
for other people. :)
—
Reply to this email directly, view it on GitHub
<#1962 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AN6GOB3XULQSED2NYZX72ALWDAHFDANCNFSM6AAAAAAQZDTLI4>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
hi @spydon i would like to take on this |
Thanks for the quick reply @basil08, I'll assign this to @dipakp2726 since @TheZal still has an open PR to finish. |
Bridge package docs for
flame_fire_atlas
This bridge package should have its own documentation section on the docs site, similarly to
flame_audio
for example:https://docs.flame-engine.org/main/flame_audio/flame_audio.html
For inspiration (and copy-pasting) you can have a look at the documentation for the package written in the
README.md
file and the documentation that the package is bridging too.Good to know
Make sure that you comment on the issue that you will be working on this before starting to program.
To set up the Flame environment you need to follow the instructions in our contributing.md doc, if you have any problems setting up your environment (or other issues of course) feel free to ask for help in the Flame channel on our Discord server.
Since this is a documentation change, you need to be able to build the docs. You can do that by running
melos sphinxdoc
after you have followed the instructions in the contributing.md doc and also installed Sphinx on your system. After you have built the docs you can open thedoc/_build/html/index.html
file in your web browser to see the changes.Make sure to include a video of the example when you upload the PR so that it will be easier for us to review it. (You can attach videos directly in the PR, so no need to upload them somewhere else)
Happy hacking!
The text was updated successfully, but these errors were encountered: