Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-4018

Move api doc generation to the driver repo

    • Type: Icon: Improvement Improvement
    • Resolution: Done
    • Priority: Icon: Unknown Unknown
    • None
    • Affects Version/s: None
    • Component/s: None
    • Labels:
    • Not Needed

      Currently we use a gh-pages branch that has to be synced manually with scripts that have to be edited manually from this repository: https://github.com/mongodb-js/learn-mongodb-docs

      We should do the following:

      • Find a new location for the files we currently have in /docs (none of them are externally referenced or packaged, to my knowledge, though we should double check)
      • Copy the files currently on the gh-pages branch into the docs directory in the driver
      • Bring over whatever build script is required to generate the current api docs and add them under a "/main" api docs url
      • Add a script that copies the docs from main to a specified version for when we want to publish a minor or major release

            Assignee:
            bailey.pearson@mongodb.com Bailey Pearson
            Reporter:
            daria.pardue@mongodb.com Daria Pardue
            Daria Pardue
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: