Skip to content
GitLab
  • Menu
Projects Groups Snippets
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • bob bob
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 2
    • Issues 2
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • bob
  • bobbob
  • Issues
  • #243
Closed
Open
Created May 08, 2017 by Guillaume HEUSCH@heuschMaintainer

"Core" documentation is too complex and should be reorganised

Dear all,

I found it confusing for a newcomer to follow all the documentation (install, tutorial, development, database...) attached to this package, and displayed on the same page.

Here's what I suggest for the installation instruction:

  • minimal instructions on how to install bob (i.e. core packages) using conda (and only this). This means:
    • merge the binary installation / detailed installation instructions into a single, simple set of commented instructions
    • remove stable bob installation instructions
    • move the compiling from source section to another page (people willing to do that should be able to dig a bit deeper into the doc)

The tutorials should be placed elsewhere too (installing and using are not the same thing, not to mention developing). Moreover, from Bob's homepage, clicking on install or on documentation will redirect you to basically the same page.

Again, in my opinion, the tutorial should be separated from the installation instructions, and should only contain more or less basic stuff - just a few examples (such as loading an image) . Then, a list of packages with a small desciption on what it does shoul dbe displayed, with link to the package documentation.

Another, different page should be set up with instruction for package development too.

What do you think ? ping @bob

Assignee
Assign to
Time tracking