Coder Social home page Coder Social logo

Comments (8)

gonuke avatar gonuke commented on September 16, 2024

We need a plan for developer documentation:

  • which parts are in Doxygen
  • which parts are in Sphinx
  • which parts are in GH issues

Will there be overlap (generally discouraged because of inevitable consistency problems)?

from dagmc.

gonuke avatar gonuke commented on September 16, 2024

Some things to track:

  • user feature list vs. what is working and what is not
  • decisions that will impact future development, e.g. conventions for naming of regions & materials
  • build process/decisions

from dagmc.

julamot avatar julamot commented on September 16, 2024

Tasks for public pages that are created via Sphinx:

  • Add a FluDAG bullet under 'Single Physics Analysis Tools' on svalinn.github.com (github.com/svalinn/svalinn.github.com). Note: This page is not in the doc-src tree.
  • Add sub-bullet linking to repository
  • Add sub-bullet linking to userguide (fludag-intro.rst)
  • Create fludag-intro.rst with workflow documentation and user feature status table
  • Put the user feature status table into Sphinx, link to the FluDAG section created in the previous step,

from dagmc.

julamot avatar julamot commented on September 16, 2024

For for the doxygen/Code Documentation portion

  • Fill out Doxygen for the feature list wrapper functions with more detail.
  • Add the fludag-calls.rst document containing a table of wrapper calls, descriptions and their status

from dagmc.

gonuke avatar gonuke commented on September 16, 2024

See https://github.com/svalinn/DAGMC/blob/fludagwork/FluDAG/README.rst#planning for some project management concepts

from dagmc.

makeclean avatar makeclean commented on September 16, 2024

Is this going to be done, it seems like it hasnt been touched in quite some time?

from dagmc.

gonuke avatar gonuke commented on September 16, 2024

Under its original title, thi is probably overcome by events and no longer necessary - it was intended as a mechanism to accomplish our goal for developing FluDAG. If we want to turn it into a documentation issue, then we can probably move it to existing issues on documentation or make a new issue.

from dagmc.

gonuke avatar gonuke commented on September 16, 2024

overcome by events

from dagmc.

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.