Giter Club home page Giter Club logo

Comments (16)

Progi1984 avatar Progi1984 commented on May 9, 2024

@MarkBaker Is it possible to not include help for JAMA ?

from phpexcel.

maartenba avatar maartenba commented on May 9, 2024

The old files can go, Documentation/assets may contain some that we want to keep (basically architectural schemas)

from phpexcel.

Progi1984 avatar Progi1984 commented on May 9, 2024

@maartenba But with PHPDoc, normally, we have a class hierarchy (like that : http://demo.phpdoc.org/Responsive/graph_class.html) which can replace that ?

from phpexcel.

maartenba avatar maartenba commented on May 9, 2024

Indeed. In that case, I think it's safe to remove those files

from phpexcel.

MarkBaker avatar MarkBaker commented on May 9, 2024

The assets images appear in the documentation and are a lot easier to read because they show just the few relevant elements from the phpdoc mapping, in the context of the documentation. As such, I think they should remain.

from phpexcel.

Progi1984 avatar Progi1984 commented on May 9, 2024

@MarkBaker : Are they uptodate ?

from phpexcel.

MarkBaker avatar MarkBaker commented on May 9, 2024

The ones I'm looking at are up to date, though they may not all be.... I'll check later. Most are simply xml files, or images created from those xml files.
It might be an idea to switch them to a different (more generic) format like GraphViz which would make them easier to edit.

from phpexcel.

Progi1984 avatar Progi1984 commented on May 9, 2024

In the directory, we can include a phpdoc of PHPExcel correctly generated with graphviz (the render is perfect, i try it this morning)

OR

We can create a branch (or a repo) dedicated to the doc (including Users documentation and PHPDoc for developpers) which permit to answer in part to the bug GH-#1

from phpexcel.

Progi1984 avatar Progi1984 commented on May 9, 2024

@MarkBaker In this zip (http://dl.free.fr/vqf8kX2if), there is the generation of PHPExcel's documentation with PHPDoc.

You can see the generated graphviz.

from phpexcel.

Progi1984 avatar Progi1984 commented on May 9, 2024

@MarkBaker Another idea : I create GitHub Pages for managing pages for PHPExcel (GH #17) which create a branch gh-pages... and in a directory of this branch, we store a generation of PHPExcel documenation with PHPDoc...

This permits developers to see it online easily and solve in part the GH #1

from phpexcel.

Progi1984 avatar Progi1984 commented on May 9, 2024

With commits f2803e8 and 9907ef9, @MarkBaker has cleaned JAMA.

from phpexcel.

Progi1984 avatar Progi1984 commented on May 9, 2024

Could we move documentation in phpoffice.github.com repo ?

from phpexcel.

Progi1984 avatar Progi1984 commented on May 9, 2024

@MarkBaker & @maartenba : What do you think about putting documentation in a dedicated branch, or a dedicated repo ? And why not in repo https://github.com/PHPOffice/phpoffice.github.com which manages http://phpoffice.github.com/ ?

from phpexcel.

maartenba avatar maartenba commented on May 9, 2024

Sounds good

from phpexcel.

Progi1984 avatar Progi1984 commented on May 9, 2024

@maartenba for which one ? 😜

from phpexcel.

maartenba avatar maartenba commented on May 9, 2024

Both :-)

from phpexcel.

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.