@jaapio@phpc.social avatar

jaapio

@jaapio@phpc.social

https://phpc.social/@phpdoc maintainer,
developer at Tilaa,
Opensource lover

With more than 10 years of professional software development I like to help teams and projects improve their documentation. Because I do belief that we should generate documentation. Not write it.

I'm building tools and libraries to help you with just that, so you don't have to. And can focus on what matters... your product.

I prefer #php as my main language, but when needed I can write other languages as well.

This profile is from a federated server and may be incomplete. Browse more on the original instance.

jaapio, to random
@jaapio@phpc.social avatar

I announce the immediate availability of phpDocumentor/guides 1.0.0.

Read my full story on Linkedin or the image attached to this message.
https://www.linkedin.com/feed/update/urn:li:activity:7170173363275943936/

jaapio, to php Dutch
@jaapio@phpc.social avatar

I was remembered today that opensource is much more than just writing code together. It's about knowledge sharing, teach other developers how to deal with certain issues. This is even more rewarding than writing a piece of code. #oss #php

jaapio, to php Dutch
@jaapio@phpc.social avatar

I learned about an idea that lives in our community to start a foundation to help the community.
Yes I know we have the @thephpf, that's mainly focused on core development of php. #php is much larger than just the language, we have user groups, conferences, meetups, speakers, opensource projects and their maintainers.
Most of them operate for free, but they have expenses. speakers at php conferences do not get paid, part of their expenses are covered but not all.

Let's talk!

jaapio,
@jaapio@phpc.social avatar

If you don't want to talk directly but want to learn more about what we are up to. Check out our vision document: https://github.com/phpcommunity/policies/blob/main/foundation/vision.md

Let's get in touch when you are ready!

jaapio, to delhi Dutch
@jaapio@phpc.social avatar

On May 30, I will talk about dead , and how to bring your docs alive. Are you joining me and become Dr Frankenstein?

,

https://www.meetup.com/brabantphp/events/300465423/

jaapio, to php
@jaapio@phpc.social avatar

When writing documentation about your application I find my self creating lists of classes. Opening up my editor, and search for all implementations of classes that extend a base class.

So why would we not just automate this shit? @phpdoc next release will have the first draft implementation for this feature.

Write your documentation in RsT and query the api docs to create a list:

jaapio, to foss
@jaapio@phpc.social avatar

In the past 5 years that I have been working for @ingewikkeld I was able to spend almost every Friday on my open source work. Which sums up to about 20% of my time with @Skoop and @mvriel. A full year of development!

Curious what #foss can do for you or your company? Talk to @Skoop he is able to explain this very well!

jaapio, to php Dutch
@jaapio@phpc.social avatar

For a podcast, I'm looking for people in the php community that would like to talk with me for about 10 to 15 min about static analysis in php. Recording can be done online, and podcast will be free available. #IngewikkeldSession

Drop me a message if you would like to share your story. How static analysis helps you in your daily work. #php

jaapio, to wordpress
@jaapio@phpc.social avatar

I have been working on the new @phpdoc extensions feature today... A first impression of what you could do with extensions.

A new extension that allows you do add #wordpress hooks to you docs!

jaapio, to opensource Dutch
@jaapio@phpc.social avatar

Years ago I started planning my #opensource work to ensure I spent some time on it every week. By that time Tuesday evening was the most suitable evening. And I still do this every week. Yes, sometimes I skip a week, but it helps to plan things you like. Who is with me? #php #foss

jaapio, to php
@jaapio@phpc.social avatar

I really enjoyed building a prototype of a new feature in @phpdoc, in this case it was back on my list because of a question I got.
Not that I would develop just any random feature by request... but this was on my list for a long time.

From now on, phpdoc will have automatically generated uml diagrams based on your project.

For me, this a huge step forward towards a goal, making a thing in

Thanks @dgoosens for your question, that confirmed the need for this!

jaapio,
@jaapio@phpc.social avatar

BTW, I'm looking for feedback, https://github.com/phpDocumentor/phpDocumentor/commit/1ee5b84eb37b82279075f7551740542bb5b62788

Get your feed wet, and give it a try!

jaapio, to php Dutch
@jaapio@phpc.social avatar

Scary thought... Did you know that a large number of #php infrastructure projects are maintained by 1 single person, some 2 or 3... But the original maintainer has been doing that for more than 20 years+ what would happen if they step down?!
They will retire at some point... Who will take over? Shouldn't we invest in the future and start education on how to maintain a opensource project with millions of users?

jaapio, to random Dutch
@jaapio@phpc.social avatar

Thank you @getsentry for sponsoring my work on @phpdoc

Do you want to help me as well to spend more time on phpDocumentor, have a look at our GitHub page for the options!

jaapio, to markdown Dutch
@jaapio@phpc.social avatar

I'm investigating options that are available to create a table of contents in #markdown, really wondering what people are using to create that when writing markdown based docs.

Please boost for reach.

#documentation

jaapio, to php Dutch
@jaapio@phpc.social avatar

Spend 6 hours squize out 4 minutes more minutes of the rendering process of changelog rendering. By now the rendering process without cache takes 2.15 min on my laptop.
This does not only save time but also a lot of computing power. How much CO2 reduction would this be in the long term?

jaapio, to wordpress Dutch
@jaapio@phpc.social avatar

He #wordpress devs how are you documenting your custom plugin hooks?
Do you have some examples for me to look at?

Cc @milana @jrf_nl
#php

jaapio, to php Dutch
@jaapio@phpc.social avatar

I'm gonna make you feel old... Remember #php 5 was released in 2004.
To me this means that I have been writing php for 20 years now. How about you?

jaapio, to foss Dutch
@jaapio@phpc.social avatar

I contributed to two new projects today. I'm using both for a client. One was a typo in a variable preventing the object from being serialized properly. The other was a wrong example in the documentation of a package that cost me a few hours to figure out what I was doing wrong.
How did you improve your #foss today?

jaapio, to php Dutch
@jaapio@phpc.social avatar

I'm in the process of creating a new version of @phpdoc ReflectionDocblock component. Internally quite some things have been improved, and a lot of stuff has been added. But it feels so scary to release a new version of a project which was downloaded 7 million times last month.

#php #onmyown

jaapio, to ai Dutch
@jaapio@phpc.social avatar

Dear internet, I would like to make it easier to searching and interact with my documentation. Introducing ChatGPT would be an option. But I do not want any other company to access my project internals. What options do I have?
I prefer open source tools, as I might want to build this into an open source project
#ai #llm #documention #chatbot

jaapio, to random Dutch
@jaapio@phpc.social avatar

@jrf_nl I'm searching for a sniff to enforce a file level comment in each file in my repositories. What would be the best way to find such a sniff? Rather than spamming you? 🤪

jaapio, to php Dutch
@jaapio@phpc.social avatar

What if your class api docs, generated by @phpdoc would be available via an api?

I'm trying to find a way to create inter project references, that allow your api to consume the docs of your dependencies.

For example, if you base a project on classes from your framework, extend the base classes, implement interfaces. I think it would be nice to have that in your docs. With links to the original source.

What do you think?
#docs #api #php

awoodsnet, to random
@awoodsnet@phpc.social avatar

@ramsey what did you use to make thai site? Looks fantastic! https://uuid.ramsey.dev/en/stable/index.html

jaapio,
@jaapio@phpc.social avatar

@ramsey it was, about 8 years ago we changed our goal. phpDocumentor will be a documentation framework. That's what we are working on right now. since 1 year we have had full support for RST. Markdown is still experimental, but also ready to be tested by end users.

I will keep building on this until we have the ultimate documentation tool for php. That can generate uml diagrams out of code, and fully integrates api docs with developer docs.

See our docs for examples

@heiglandreas @awoodsnet

jaapio,
@jaapio@phpc.social avatar

@ramsey it's production ready. The RST parser is a collaboration with the documentation team. They recently switch to our parser completely.
phpDocumentor itself doesn't contain the latest version yet. I expect a new release somewhere this month. Since 3.3 it's really usable.

We do have a GitHub action so it's easy to integrate in your pipelines. No hosted solution right now. But maybe that will follow in the future. Might be a nice idea. However GitHub pages also works.

  • All
  • Subscribed
  • Moderated
  • Favorites
  • •
  • megavids
  • thenastyranch
  • rosin
  • GTA5RPClips
  • osvaldo12
  • love
  • Youngstown
  • slotface
  • khanakhh
  • everett
  • kavyap
  • mdbf
  • DreamBathrooms
  • ngwrru68w68
  • provamag3
  • magazineikmin
  • InstantRegret
  • normalnudes
  • tacticalgear
  • cubers
  • ethstaker
  • modclub
  • cisconetworking
  • Durango
  • anitta
  • Leos
  • tester
  • JUstTest
  • All magazines
    •