Git Product home page Git Product logo

Comments (7)

claremacrae avatar claremacrae commented on May 23, 2024

Here are some tutorials in other C++ projects that I think are well-structured:

Extra pointers appreciated!

from approvaltests.cpp.

barneydellar avatar barneydellar commented on May 23, 2024

In the Introduction, I would add in a “What is Approval Testing” section first, just so people know what kind of thing they’re looking at.

from approvaltests.cpp.

claremacrae avatar claremacrae commented on May 23, 2024

In the Introduction, I would add in a “What is Approval Testing” section first, just so people know what kind of thing they’re looking at.

Done! Thanks @barneydellar

from approvaltests.cpp.

claremacrae avatar claremacrae commented on May 23, 2024

Maybe add something like “Requirements and Dependencies”

from approvaltests.cpp.

claremacrae avatar claremacrae commented on May 23, 2024

A nice trick that the Catch2 docs use is to put a top target in each page, and then link like this:

https://github.com/catchorg/Catch2/blob/master/docs/tutorial.md#top

This hides all the github boilerplate UI at the top of the page, so all the reader sees is the documentation, which makes it look a bit more professional.

from approvaltests.cpp.

claremacrae avatar claremacrae commented on May 23, 2024

Once the structure settles down, add a Contents section at the start of each page - see the Catch2 tutorial link above.

from approvaltests.cpp.

claremacrae avatar claremacrae commented on May 23, 2024

I'm going to declare the structure of the User Guide as good enough, and crack on with filling in the blanks. So marking this as closed.

from approvaltests.cpp.

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.