Git Product home page Git Product logo

Comments (1)

zstix avatar zstix commented on June 28, 2024

We spoke with some stakeholders and evaluated a few options. We have decided that we do not want to store all markdown files within a single directory. We would like to either make a fully-nested structure that mimics the category hierarchy or make a single-level structure where we have top-level category buckets.

Moving forward, we are going to try to migrate some content with one of these strategies and re-evaluate. I'm going to move this ticket to the next MMF, since that is when we will do that evaluation.

Meeting Notes

  • Use a nested hierarchy to store the files, with the hierarchy reflecting where a doc actually lives (for example, a doc at the first level would live in /Folder-A , while a doc at the second level would live at Folder-A/Folder-B . And so on.
  • We want the URL structure, the public-facing navigation, and the repo structure to all align.
  • We'll re-check this decision a bit later on when we do a simple test migration with doc/navigation titles that match the actual site.
  • Putting a doc in multiple places in the hierarchy is a technical puzzle we'll need to solve for.
  • We'd also like to explore automation/tooling to ensure that the directory, URL, and navigation stay aligned and don't drift

from docs-website.

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.