Skip to content

Conversation

troysgit
Copy link

Description

Rough draft to discuss including a short summary section at the head of a docs page, I think either essentials or collections and data structures, for new users to be able to use to more quickly figure out how to write some basic programs.

Changes made

Listed some foundational data structures/functions (these are the items for discussion if the idea of including a summary is welcome) available in Julia that might be commonly encountered and used by beginners.

Testing

Ensured change renders correctly.

Notes

Seeking discussion around slight documentation addition to enhance the productivity of a potential first time user of Julia.

  • Side note: would maintainers prefer this as a discussion on discourse with an image attached or here as a draft PR?
summary_potential

Copy link
Member

@adienes adienes left a comment

Choose a reason for hiding this comment

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

thank you for the PR, but I don't think this is a great fit for manual-style documentation (also --- this is an odd set of things to "start with" as it's just a list of a few types? and has nothing much to do with the true first steps of learning how to code)

something like this would probably be better suited as a tutorial-style blog post, or maybe in something like https://github.com/modernjuliaworkflows/modernjuliaworkflows.github.io

@troysgit
Copy link
Author

this is an odd set of things to "start with" as it's just a list of a few types? and has nothing much to do with the true first steps of learning how to code

I was thinking more for people who already know how to program but are new users to Julia specifically.
If one navigates to the docs -> essentials -> collections and data structures, it's straight to Iteration rather than a quick summary of some starting points i.e. if someone is competent with python or R they may just want to write a small existing program of theirs in Julia as a trial.
The intent being to get people small successes with the language more quickly in a time pressured world.

something like this would probably be better suited as a tutorial-style blog post, or maybe in something like https://github.com/modernjuliaworkflows/modernjuliaworkflows.github.io

Understood :)

@nsajko nsajko added the docs This change adds or pertains to documentation label Aug 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants