Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Organization of the Docs

See original GitHub issue

Our top level of he docs is currently

Why SimPEG?
Getting Started with SimPEG
Getting Started: for Developers
Practices
Examples
Electromagnetics
Direct Current Resistivity
Induced Polarization
Magnetics
Richards Equation
Finite Volume
Forward Problem
Inversion Components
Maps
Utilities

It isn’t necessarily clear where a user or new contributor should start or how they should navigate through the docs. We can add a :caption: in the toctree to help clarify how things are grouped. (see for example: http://docs.readthedocs.io/en/latest/theme.html). What about the following

About SimPEG

Why SimPEG
Examples
Getting Started
Contributing
Practices

Geophysical Methods

Gravity
Magnetics
DC Resistivity
Induced Polarization
Time Domain Electromagnetics
Frequency Domain Electromagnetics
Natural Source Electromagnetics
Vadose Zone Flow

Core

Finite Volume Discretization
Forward Simulation
Inversion Components
Maps
Utilities

Thoughts? cc @simpeg/simpeg-developers, @dougoldenburg

Issue Analytics

State:
Created 6 years ago
Comments:6 (6 by maintainers)

Top GitHub Comments

1reaction

dccowancommented, Feb 22, 2019

Hi @lheagy and @rowanc1 . I have a few thoughts.

I like the numpy format for auto-generating the API that was suggested for the discretize repository. See https://github.com/simpeg/discretize/pull/134
Where do we want to put the background theory for how problems are solved numerically? Do we want to put this in the docstring for each problem class and have it generate as part of the API? Do we want to make a theory section? Personally, I think the user should be able to find this information if they want.
To reach people without a high level of programming ability we were going to use a lot of examples. Did we want to consider an organisation strategy for the documentation based more around examples?

So we don’t have a bunch of bullet pointed lists in this GitHub issue, I have made a google doc. It can be modified until consensus is reached.

https://docs.google.com/document/d/1kXVsbMf-oMtr93EtoNTquiGbAQ4JTEdcJiosdNP6piU/edit?usp=sharing

1reaction

dccowancommented, Jul 30, 2018

@lheagy I’ve actually spent some time fixing bugs related to generating the docs and including IP and VRM. If we reach a consensus on where things should go, I don’t mind pitching in.

Top Results From Across the Web

Organizations — Read the Docs user documentation 9.0.0 ...

Organizations allow you to segment who has access to what projects in your company. Your company will be represented as an Organization, let's...

About Our Organization - Write the Docs

Write the Docs is a global community of people who care about documentation. We have a Slack community, conferences on 3 continents, and...

Introduction | Season of Docs | Google Developers

Organization administrators are members of the participating open source organizations who act as the principal Season of Docs contact for their organization.

AWS Organizations and AWS Account Management

User Guide. Introduces you to AWS Organizations, helps you set up an organization by creating accounts or inviting other accounts to join.

File Organization in Google Docs - YouTube

This video tutorial demonstrates how to organize and sort your files in Google Documents.This video tutorial includes:Overview of ...