Giter Site home page Giter Site logo

Comments (1)

michaeluno avatar michaeluno commented on August 16, 2024

Hi, thanks for your offer.

the search function isn't what it could be.

The documentation has been generated with ApiGen 2.8.0 with a custom template and the search functionality totally depends on the ability that ApiGen provides.

the organization is a little hard for a newcomer to sort out.

I'm not following what you mean.

there's a blue stripe ... looks like a panel separator ... right in the middle of doc pages.

Can you post a screenshot? Maybe it is a problem of the documentation generator.

By the way, I have renewed my development environment and tried to install ApiGen but somehow got dependency issues and unable to install it. We should find another documentation generator and host those generated files on GitHub Pages so we can leave search functionality to search engines like Google, Bing, DuckDuckGo and so on. This way, collaborators can update the documentation whenever possible.

The reason I used ApiGen 2.8.0 is that it supported the @package annotation to be parsed like @package AdminPageFramework/Utility and create corresponding sub-sections in the resulted pages. When I tried some tools several years ago, most of them did not support it.

We have to find a good documentation generator first. If you find a good one, let me know. If we cannot find a good one, then I have another idea.

from admin-page-framework.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.