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

Streamlit documentation tutorial #143

Merged
merged 6 commits into from
Sep 25, 2024
Merged

Conversation

daezel
Copy link
Contributor

@daezel daezel commented Sep 22, 2024

Please check the following - and then delete this message:

  • If you are creating a new page, does it contain the following value at the top, with x being the position in the folder?
---
sidebar_position: x
---
  • If you are creating a new sub-folder, does it have a _category_.json file with the appropriate descriptive information?
  • Are all your images / videos named appropriately and in the correct location ("image1.png" e.g. will not be accepted)
  • Are all your code blocks properly closed off?
  • Does your file have an appropriate and descriptive file name, and main header?
  • Ensure all files are referenced correctly (They are case sensitive - if you save "image.png" you cannot reference "Image.PNG")

Failure to include these will result in your request not being reviewed.

@daezel daezel requested review from SassafrasAU and a team as code owners September 22, 2024 07:25
Copy link
Contributor

@SassafrasAU SassafrasAU left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Handful of small changes needed:

  • Can you add the sidebar_position to the top please, see the PR instructions on the exact usage.
  • The URLs with < > around them need to either have that removed, or changed to the typical format of text

@daezel
Copy link
Contributor Author

daezel commented Sep 25, 2024

  • Updated raw URLs to Markdown link syntax for better readability and professionalism.
  • Added 'sidebar_position' to the Streamlit tutorial section to improve navigation.

@daezel daezel requested a review from SassafrasAU September 25, 2024 02:05
@SassafrasAU SassafrasAU merged commit d59aa06 into Redback-Operations:main Sep 25, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants