Suggestions for GF docs structure

[RosaWagner]

So I think we agree the docs and the spec are delivering a lot of useful informations, although it is kind of overwhelming and could need a bit more structure. As a first step of reviewing the docs I would like to suggest this structure:

.
├── 000 Spec
├── 100 Starter
│   ├── 110 Start with Google
│   │   ├── 111 Libre font philosophy
|   │   └── 112 Tools
│   ├── 120 Start with Github
|   └── 130 Start with a font editor software
├── 200 Design
│   ├── 210 Design tips and tricks
│   │   ├── 211 Design resources
|   │   └── 212 Latin diacritics
│   ├── 220 Get your masters ready for production
│   │   ├── 221 Contours
│   │   ├── 222 Components and anchors
|   │   └── 223 Charset and Glyphset
│   └── 230 Font info settings
└── 300 Get ready for GF
    ├── 310 Upgrading existing repository
    ├── 320 Set up a build script
    ├── 330 Mastering families
    │   ├── 331 Naming
    │   ├── 332 Vertical metrics and alignment zones
    │   └── etc
    ├── 340 Reviewing families / QA process
    ├── 350 Bug and hotfix
    ├── 360 Local testing
    └── 370 Packaging for GF

Agree, disagree, PR, not PR ?

[m4rc1e]

Sounds like a good idea but I'm worried we'll break the hyperlinks by doing this. If we're able to redirect then I have no problem.

[RosaWagner]

Actually, some of the hyperlinks need to be refreshed too, it could be the opportunity to check them all (a lot of work though). But I mostly wonder if it will create conflict with other non-merged branches.

[graphicore]

a lot of work though

could maybe be automated. There might even already be a project that checks md files in github repos for broken links.

[graphicore]

There might even already be a project that checks md files in github repos for broken links.

This https://github.com/tcort/markdown-link-check ?

[davelab6]

The overall structure is good. Rather than numbered files, I propose taking these files into a gh-pages branch and Jekyll website format, and using the jekyll frontmatter to provide the order.

Couple of examples:

• http://designwithfontforge.com
• https://silnrsi.github.io/silfontdev

[RosaWagner]

The overall structure is good. Rather than numbered files, I propose taking these files into a gh-pages branch and Jekyll website format, and using the jekyll frontmatter to provide the order.

I have no idea how to do that but will make some research and propose something.

Is there a way to create some kind of a structured bibliography with the links used in different md files? And the concerned md and the one in the bibliography would be also linked (if you change one, the other is also modified).