Great article! One question: What is a good way to add search to my documentation? I write my docs in markdown and export the markdown to HTML. The docs are in a GitHub respiratory with the Web site feature turned on.
I've used Lunr to add search, but am not thrilled with the way it works. It doesn't highlight the search keywords in the documents it finds, nor have I found a way for it to open an internal link in a document.
I'm Deividas Strole, a software developer skilled in Java, Spring Boot, React, and AI. I hold CS and Software Engineering degrees and love learning, coding, and building smart, useful solutions.
Location
Los Angeles, CA
Education
Bachelor's degree in Computer Science from CSUN, Master's degree in Software Engineering from NU.
Work
Full-stack developer at WMGS by day, open source contributor by night. Student mode: forever!
Such a nice read! I learned so much about best practices of API Documentation. THank you Emmanuel Mumba!
Thank you. Glad I could Help
Good read!
Awesome! Thank you.
That's a goo done, Emmanuel!
Great article! One question: What is a good way to add search to my documentation? I write my docs in markdown and export the markdown to HTML. The docs are in a GitHub respiratory with the Web site feature turned on.
I've used Lunr to add search, but am not thrilled with the way it works. It doesn't highlight the search keywords in the documents it finds, nor have I found a way for it to open an internal link in a document.
Very insightful. Thx!
Software documentation should explain not really what that peace of code does, but why. AI code documentation tools are not god at this yet.
Thank you Good read
Wow cool. Good job.
Senseless AI-generated content. Sad.