Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • G general-issue-tracker
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 47
    • Issues 47
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • mumu
  • general-issue-tracker
  • Issues
  • #26
Closed
Open
Issue created Feb 13, 2015 by John Zhang@u5157779Developer

Tutorial and Spec versioning

Created by: wks

I am evaluating http://readthedocs.org/ . A µVM tutorial is being written.

Jekyll seems to bias strongly towards blogging and the structures (including a table of content and a per-page sidebar of the outline) are not automatically handled.

There should be a common version scheme for the spec, the refimpl and the tutorial. I propose using the major version "2" for the current version. The tutorial will target the "main" version (currently "2").

GitHub Wiki sucks (very primitive structure support, no table of content). Considering migrating the specification (https://github.com/microvm/microvm-spec/wiki) back to Sphinx/reStructuredText if readthedocs.org is proved useful.

Assignee
Assign to
Time tracking