Skip to content

Minimal fix of intro for 2026#329

Merged
frankier merged 3 commits into
coderefinery:mainfrom
mmesiti:fix-intro-spring2026
Mar 20, 2026
Merged

Minimal fix of intro for 2026#329
frankier merged 3 commits into
coderefinery:mainfrom
mmesiti:fix-intro-spring2026

Conversation

@mmesiti

@mmesiti mmesiti commented Mar 18, 2026

Copy link
Copy Markdown
Contributor

Fixes #328

  • readthedocs.org -> ghpages
  • mention personal/project page is optional
  • plausible time table
  • consistency between list of episodes and content of intro

Note: still independent of other PRs (most importantly: #325)

@mmesiti
mmesiti requested a review from frankier March 18, 2026 08:46
@bast

bast commented Mar 19, 2026

Copy link
Copy Markdown
Member

This conflicts now but let me know if I can help resolving.

@samumantha samumantha left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice clarification!

- readthedocs.org -> ghpages
- mention personal/project page is optional
- plausible time table
- consistency between list of episodes
  and content of intro
@frankier

Copy link
Copy Markdown
Contributor

LGTM -- but is it really "independent of programming languages"? At least the API docs are not. This seems more like a goal than the actual state of things. Maybe hedge with "mostly"?

For documentation tools, leaning into the language specific ones come with the benefit of ecosystem convention: less configuration/boilerplate and consistent experience browsing different library documentation.

@mmesiti

mmesiti commented Mar 19, 2026

Copy link
Copy Markdown
Contributor Author

LGTM -- but is it really "independent of programming languages"? At least the API docs are not. This seems more like a goal than the actual state of things. Maybe hedge with "mostly"?

I sympathize with this, but to be utterly precise, we claim that the demonstration is independent of programming languages. Which still is not, completely, because conf.py is written in python. So amending this.

For documentation tools, leaning into the language specific ones come with the benefit of ecosystem convention: less configuration/boilerplate and consistent experience browsing different library documentation.

One could argue that the sphinx exercise could be split into different tabs, one for each relevant programming language and tool. But - is there demand for that? Should we add pkgdown/doxygen/documenter.jl examples for the next workshop? Food for thought for another time.

@mmesiti
mmesiti force-pushed the fix-intro-spring2026 branch from 0bce038 to 3ecda63 Compare March 19, 2026 14:55
@mmesiti

mmesiti commented Mar 19, 2026

Copy link
Copy Markdown
Contributor Author

fixed conflict, force pushed, addressing @frankier 's comment, hopefully. @frankier might merge if satisfied.

@samumantha

Copy link
Copy Markdown
Member

One could argue that the sphinx exercise could be split into different tabs, one for each relevant programming language and tool. But - is there demand for that? Should we add pkgdown/doxygen/documenter.jl examples for the next workshop? Food for thought for another time.

  • Yes please, any tool that others may use :) please add an issue!

@frankier
frankier merged commit bfbe0b2 into coderefinery:main Mar 20, 2026
2 checks 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.

review intro page/index

4 participants