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

Alexis docs hackathon #1 Aug 23 #736

Merged
merged 1 commit into from
Aug 30, 2024
Merged

Alexis docs hackathon #1 Aug 23 #736

merged 1 commit into from
Aug 30, 2024

Conversation

AlexisRenchon
Copy link
Member

@AlexisRenchon AlexisRenchon commented Aug 22, 2024

Working on ClimaLand docs 1 day a month - Alexis August 23

https://clima.github.io/ClimaLand.jl/previews/PR736/

  • index: explain we have docs "for users" and "for developers"
  • index: explain that we use SI units
  • getting started: discoverability and help of ClimaLand, tree of package structure (submodules, exported functions and type), how to get info
  • reorganize a bit: API now last, tutorials after getting-started, etc.

!! Note: about(ClimaLand) in getting-started does not show functions, modules and type by colors in julia 1.10 (it will in julia 1.11), so the line below mentioning what the color mean looks a bit weird, but julia 1.11 should be here soon.

@Sbozzolo
Copy link
Member

https://sbozzolo.github.io/kuibit/features.html

@AlexisRenchon AlexisRenchon requested a review from Sbozzolo August 30, 2024 21:28
@AlexisRenchon AlexisRenchon marked this pull request as ready for review August 30, 2024 21:30
Copy link
Member

@Sbozzolo Sbozzolo 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! I think this is a good starting point and we can iterate over it with time.

docs/make.jl Outdated Show resolved Hide resolved
docs/src/getting-started.md Outdated Show resolved Hide resolved
docs/src/getting-started.md Outdated Show resolved Hide resolved
docs/src/getting-started.md Outdated Show resolved Hide resolved
docs/src/getting-started.md Outdated Show resolved Hide resolved
docs/src/getting-started.md Outdated Show resolved Hide resolved
docs/src/getting-started.md Outdated Show resolved Hide resolved
docs/src/getting-started.md Outdated Show resolved Hide resolved
docs/src/getting-started.md Outdated Show resolved Hide resolved
docs/src/index.md Show resolved Hide resolved
@AlexisRenchon AlexisRenchon force-pushed the ar/docs_hackathon branch 2 times, most recently from 5a49410 to d187bc1 Compare August 30, 2024 23:01
ClimaLand.jl documentation had no landing page for a while, and then
just a small line. In this commit, we add a better home page as well as
a getting started page. The documentation navigation has been slightly
refactored as well.
@AlexisRenchon AlexisRenchon added the documentation Improvements or additions to documentation label Aug 30, 2024
@AlexisRenchon AlexisRenchon merged commit d4ae40d into main Aug 30, 2024
7 of 9 checks passed
@AlexisRenchon AlexisRenchon deleted the ar/docs_hackathon branch October 21, 2024 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants