-
-
Notifications
You must be signed in to change notification settings - Fork 25
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
Add meeting note from Feb 2024 #106
Conversation
If the items in "Follow-ups from previous meeting(s)" were not discussed, we should probably remove this section. |
Co-authored-by: Ege Akman <[email protected]>
Co-authored-by: Ege Akman <[email protected]>
Co-authored-by: Ege Akman <[email protected]>
docs/monthly-meeting/2024-02.md
Outdated
[Ezio] We should also figure out what to do about collapsible sections. | ||
[Ned] What problem are collapsible sections solving? Do we have too many examples that users will want to ignore? (In my docs I use tabs, but not colapsible sections) | ||
[Ezio] If we agree to add basic examples inline, but bigger examples on the bottom, we won't need collapsible sections. | ||
[Carol] So: yes examples, yes inline. We can pause discussions about collapsible sections; if the examples get too long we should think about spinning them out into their own howto pages. **Consensus Recap** | ||
|
||
[Ezio] Would it make sense to do different things based on the builder, e.g. collapsible sections for HTML and something else for PDF? | ||
[CAM] Yes. Some current directives for collapsible sections do that. | ||
|
||
[Ned] re. pages being too long, we might switch to having a page for each function | ||
[Carol] we could run a cron job to count lines |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This part seems a bit jumbled together (not sure if the conversation was, or if the discussion was transcribed out of order).
First of all it's missing some context, such as the problems that collapsible sections, such as that they don't work with different builders. I would put this near the top, since the whole discussion becomes moot if we don't use them.
Regarding page length (and specifically examples length, if counted with something smarter than a wc -l
), the script could be used both for pages with not enough examples (so we should add more), and pages that have too many (they might be better moved to the "Examples" section or a separate page).
I would close with Carol's summary.
P.S. I'm not sure if @nedbat suggested having a page for each function, I think it was @hugovk to bring this up while talking about PHP docs, but I might be misremembering.
I find the transcript a bit difficult to read, since it tries to follow the (sometime erratic) conversations. This style also makes it difficult to add more comments, notes, and clarification afterwards. Maybe we should try to summarize each conversation with a few bullets points and either get rid of the (already abridged) transcript or move it to a separate section. @CAM-Gerlach, any thoughts about this? |
Co-authored-by: Ezio Melotti <[email protected]>
for more information, see https://pre-commit.ci
Co-authored-by: Ezio Melotti <[email protected]>
Co-authored-by: Ezio Melotti <[email protected]>
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for adding the notes PR ☀️
I am going to go ahead and merge this. We can make any corrections or style changes in a separate PR. Thanks everyone. |
📚 Documentation preview 📚: https://docs-community--106.org.readthedocs.build/en/106/monthly-meeting/2024-02.html