# MIPs Portal Changes ## Rationale The MIPs Portal was designed around the original MIP template. After the introduction of the Endgame, that template has grown obsolete and a new style of MIP has become the norm. The way the MIPs Portal displayed MIPs was ill-suited for this new style of MIP. As a consequence of this maladjustment, Endgame-stlye MIPs were rendered suboptimally and were hard to navigate. ## Summary of Changes - Subarticle numbers have a distinct style - Indentation per subarticle depth - Additionally, vertical lines make article subordination clearer - Abbreviations are automagically wrapped in `<abbr>` tags - Resolving subarticles whose depth > x.x.x.x.x intelligently so that authors need not hack them through `* **...` and can use the standard `######` instead. - Removed font size differences for headings > 3 - Other minor stylistic changes The MIP Framework currently comprises both old style and Endgame-style MIPs. These changes apply only to those proposals tagged as `endgame`. ## Results Overall, we feel that these changes benefit both authors and readers: - The former will longer need to worry over hacking deeply-embedded subarticles and adding expansions for their abbreviations (e.g., "AD (Aligned Delegate)"). - The latter will find parsing the Atlas and the Scope Artifacts much easier because of the structural and stylistic changes. - You may find some rendering issues in some MIPs in the short term. These predate these changes but are now made evident. They will be fixed by a reformatting of the affected MIPs. | New version | Old version | |--|--| |![](https://hackmd.io/_uploads/B1L8IT1C2.png)|![](https://hackmd.io/_uploads/r176IpJA3.png)| |![](https://hackmd.io/_uploads/Hk9zPpyR2.png)|![](https://hackmd.io/_uploads/BkswwakR2.png)| ## Mimimal Ad-hoc Style Guideline for Authors - Please do not use `* **` to format deeply-embedded subarticles. Stick to `######` instead for subarticles x.x.x.x.x and deeper &mdash; the MIPs Portal will resolve that for you. - Do not use parenthetical expansion for widespread abbreviations. The MIPs Portal will create `<abbr>` tags around those for you. [These are the abbreviations, by the way](https://github.com/makerdao/mips/blob/master/meta/abbrMapping.json). - Please try not to go past (nor reach!) x.x.x.x.x.x.x. The nesting helps until it harms. - Do not put the body of an article in its header: - Not: `x.x.x.x: [body of the article]`. - Instead: `x.x.x.x: [optional title]`, and the body of the article below. ## Credits A huge thank-you to @hernandoagf for his collaboration.