Skip to content
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

Closed
spydon opened this issue Sep 29, 2022 · 7 comments · Fixed by #2077
Closed

Bridge package docs: flame_fire_atlas #1962

spydon opened this issue Sep 29, 2022 · 7 comments · Fixed by #2077

Comments

@spydon
Copy link
Member

spydon commented Sep 29, 2022

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 the doc/_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!

@basil08
Copy link

basil08 commented Sep 30, 2022

Hi, would like to work on this!

@spydon
Copy link
Member Author

spydon commented Oct 1, 2022

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. :)

@TheZal
Copy link
Contributor

TheZal commented Oct 10, 2022

Is this still available? I can work on that!

@spydon
Copy link
Member Author

spydon commented Oct 13, 2022

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. :)

@basil08
Copy link

basil08 commented Oct 13, 2022 via email

@dipakp2726
Copy link
Contributor

hi @spydon i would like to take on this

@spydon
Copy link
Member Author

spydon commented Oct 14, 2022

Thanks for the quick reply @basil08, I'll assign this to @dipakp2726 since @TheZal still has an open PR to finish.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants