LDraw.org Official Parts Library Standards: Introduction

[Orion Pobursky]

It's time to start discussing the LDraw.org Official Parts Library Standards.


I'll kick this off with 2 items:

1. Is the title "LDraw.org Official Parts Library Standards" a good title? Should we use something better?
2. Review the "Introduction" section and provide feedback.

https://library.ldraw.org/documentation/...troduction

Desired feedback includes, but is not limited to:
 - Content
 - Grammar
 - Page format
 - Page styling (i.e. the overall look and feel)
 - Page navigation

[N. W. Perry]

1. Is the title "LDraw.org Official Parts Library Standards" a good title? Should we use something better?

It's good, assuming this is to replace the many current sub-topics: library header, library part number, library sticker parts…
Bringing all of these together under a unifying title would be a Good Idea™.

It would also be Good to differentiate the library regulations from the file format, by use of the words "standard" vs. "specification" (or some other). Right now we have library "standards" that contain various "specifications". Meanwhile we have the file format "specification" (though that is governed by the "standards" board). I still get all the different documentation confused with respect to these names.

2. Review the "Introduction" section and provide feedback.

I'll have more later, but just quickly I notice that the right-hand navigation sidebar on the intro section is mis-sized (requires scrolling just to fit the word "introduction"). Other pages seem to be correct.

[Rene Rechthaler]

The "auto-correct" should be done (and displayed) before the final upload
things which could be in auto-correct (maybe they are already there):
-tilde in subparts
-correct parttype prefix (subpart/prim on both part name and parttype)
-correct license

[Orion Pobursky]

The "auto-correct" should be done (and displayed) before the final upload
things which could be in auto-correct (maybe they are already there):
-tilde in subparts
-correct parttype prefix (subpart/prim on both part name and parttype)
-correct license

Good feedback. Despite my bringing it up, I think what the PT does or doesn't auto correct should probably be spun off into its own thread once we're done with section review

[N. W. Perry]

Good idea on setting off requirements in a text box; we may find there are other types of content to highlight in other kinds of boxes (deprecated practices, optional provisions, etc.).

I think there's a way to make the "Please note" section a little more clear. Something like:

"These standards have evolved over time, and there may be official parts in the LDraw.org Parts Library that do not conform to these requirements. Such parts need not be edited and re-submitted solely for the purpose of bringing them into compliance. However, all parts submitted to the Parts Tracker, whether new parts or fixes to existing official parts, must conform to the current library requirements."

[Chris Böhnke]

Looking good so far.

Missing a word?
"Text not in a block quote box is intended [to] explain or otherwise provide context to the requirement."

I really like the textboxes.

N. W. Perry:
"[...] we may find there are other types of content to highlight in other kinds of boxes [...]"

So different colored boxes or should there be a small symbol next to them? I somehow like the idea, but I'm also afraid it might cause a bit of an overload.

[N. W. Perry]

So different colored boxes or should there be a small symbol next to them? I somehow like the idea, but I'm also afraid it might cause a bit of an overload.

Probably different colored. Indeed, they should be used sparingly (and it might be good to consolidate them as much as possible).

[Orion Pobursky]

- I made the editorial changes above.
- I opened an issue for the TOC misalignment

New question: should this intro section contain a glossary?

[N. W. Perry]

New question: should this intro section contain a glossary?

I don't think so, that should appear on its own at the end. (You would still have ready access to it at any time from the TOC sidebar.)

Couldn't hurt to have links in the text to glossary entries, though.

[Travis Cobbs]

Typo:

Such part are not required to be edited...

Make "part" plural.

[Orion Pobursky]

Typo:


Make "part" plural.

Fixed.