From 61ba44cdcea9ac682fdd968ebd372077875a27b1 Mon Sep 17 00:00:00 2001 From: Nora <51166756+AnalogFeelings@users.noreply.github.com> Date: Tue, 13 Feb 2024 19:30:22 +0100 Subject: [PATCH] Improve new docs site. (#2843) * Improve parameter padding and add discord link. * Update xref service for docs. Reason: https://github.com/dotnet/docfx/issues/9659 * Update docs readme to specify docfx version. * Update to latest DocFX. * update action & add manual trigger --- .github/workflows/docs.yml | 3 ++- docs/README.md | 8 +++++--- .../DocFX.Plugin.DescriptionGenerator.dll | Bin 11264 -> 11264 bytes docs/_template/material/public/main.css | 13 +++++++++---- docs/_template/material/public/main.js | 5 +++++ docs/docfx.json | 4 ++-- 6 files changed, 23 insertions(+), 10 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1b56965821..e58fcaafc8 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -4,6 +4,7 @@ on: push: tags: - '*' + workflow_dispatch: jobs: build: @@ -18,7 +19,7 @@ jobs: dotnet-version: 8.0.x - name: Setup DocFX - run: dotnet tool install -g docfx --version 2.71.0 + run: dotnet tool install -g docfx --version 2.75.2 - name: Build DNet docs run: docfx docs/docfx.json diff --git a/docs/README.md b/docs/README.md index 4a06dccab1..b856b8b3cd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,13 +3,15 @@ The documentation for the Discord.Net library uses [DocFX][docfx-main]. Instructions for installing this tool can be found [here][docfx-installing]. +> [!IMPORTANT] +> You must use DocFX version **2.75.2** for everything to work. + 1. Navigate to the root of the repository. 2. Build the docs using `docfx docs/docfx.json`. Add the `--serve` - parameter to preview the site locally. Some elements of the page - may appear incorrectly when hosted offline. + parameter to preview the site locally. Please note that if you intend to target a specific version, ensure that you have the correct version checked out. [docfx-main]: https://dotnet.github.io/docfx/ -[docfx-installing]: https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html \ No newline at end of file +[docfx-installing]: https://dotnet.github.io/docfx/index.html diff --git a/docs/_template/description-generator/plugins/DocFX.Plugin.DescriptionGenerator.dll b/docs/_template/description-generator/plugins/DocFX.Plugin.DescriptionGenerator.dll index 9c7b48acea816dbc9c008601aa3e02295a02c854..0eeab1bd70f384fa833f3ef6a2274471494602b2 100644 GIT binary patch delta 4293 zcmbtY3vg7`8UD|?&)rQfyLXe#0(tCi2w67Cx|@V-K#3p^p}t}g5Js_tnAlY7!X{x% z8QBd~s?|~B9UZGU4pVF!txh3hk>Y3>sjaUnmezKBGQ|fSsx!4tDO%I-oZSSlj5Cfm zIp6tT=l}on-}AUhZgp<;UAL%Dc0T&X= z^NG5gFt2ykuv+$%Gs0?lRC69-tJr-G<9=;dkcc@OBPpky*Z0^&?kFRwt7%YYm(*#| z5(sJ};O7=#(Nl3;Hj`jS=}1 z8jT<^PUN$ds!%ZRQ^{O8HB`we(Hh}g$=rELs7}g$d`fmI#%$OR)B@bPnvSC1G6&$% z>Rnn{{KnP?QENSo@b1h`3{TgAD%3Dt58AK#)Mx{UhD|;-W9)~`jC9;NsU))JK)O1e z0H%`wPhG6w=)hSW={`O0Nb%{Of@K9eOUNQ4Z)fU;sIu-hCwWs;Q+Ml`6vjDYYM3=T zFRIm9nSPuXeDTbAf^0%gFkJ>Zvswt6A(*XaHi1?OOnR=6@feD)(qfbXuhz%&<@hRp z+t2Wq{pJquJHz4E^p`!$jQ4yKhiCdb2v?aue1*TPC}Aa!wxF2#QZ7X)#lstTNsOn( zN@?Icrq;Vu$tXz|4=CxB7?4*h3Fslq>(@w?DtBlsK7a#3&xyS_6{Sr{w_>nd7=el} zSZvia7M%x4dj6CcQjwHn7**MGh4ehYl!uwvZtd7^SYbY!s>%x6jWX|Jrui*Qd^5Jb znvW#+9c7A?FKZVF*9C3hl=h4r=yDfawK_ieg z(QBHJ32v@((9r1}iC3wDewFVw{B#s~==2#spz5?(y-e5XHbr1i(vL`bxx`+H6B3VR zxiES_;_sx>O5KJe&28OHl}608s7dXHWYDyAo5m=>-85##Or74=4;lfw%N*7M^d1}5 zbb5k|gd7rMPiVsCe%j95bgwSxTQxs$9V9w^Vv4w}W>$3P%J2(i;Ez;WpFywdgL)<1 z0MiIfu*YE2A%~5?CO{>M2(}z_CGC;&i?sJJ`(;K40=SX7sMVVSP)k$}zu)0ojir)f zcpnYMR%0dV&9b;}yfmQ;)*v@2VJ~fkx!^pcK!@89oSUXe4%--9G5JW>Kc*vWRc?oN z6!-!=$}Z1csT~0p87C0vzs3>PLVuwTSpeK|;4}0oX1>Q%xK1zVCy=nq%o<=c-2)t= zX}moI|MWgXgh5YN&Vic#0^!A2IS-5x$!6s4D6}p66l&{AwL!;@E z4g=kk1bS(n#6=QUNW5I)8j0N!`z3CaI1DVsixb{<0%y`+fv7k8z{I^hokf%cb<;U| z8$?a~0t&NgeL1$;akY(-?0e>=G><*3chNrj#8`_@!(B$2R$ z4FR5&_&13QnFtx7<5bQrX4m2*Y+)POE$ktt=ESl){aJ?t+r;{tdiJyB(t;z6Q>HO- z5y;zM(r`cf8CLI?WdS*aAu)Uc$mbxAWI>$iZ&03%(y34`M%&Li&JyG?X{ce->1YO8 zEnLr|J7@vzrSs`!x{y8uzlAw}p0+`~xPM@9e6e?>Vs-TPb$0jl4i0w=UEez}euw{d zKE5olmydrQ>{7h<9gaTr+z0P2-8BaNTgr2yxT$mSO<6Ow%a! z4Rg!B2|oN-;3BM@dt$nw`MQzm&8(mI-Cm1Ugf@g0v_dG@8g7;6QA}a2y%sZ6@Me6bLEP>|DX@I- zx-12UEb4%Yx`Blh3``f38ZyOZ7Eh(Pue*4_`Ay|K*6N(B3ESuu2RgchS?Bz#+B50z_Vx@8I8TKm&JV+lNcq>{L}S7F@XUg>2>R%z$Sb+wlBXLZ z`op)w@#OPUL5D`e0sLv-6qz%Ab!0VjtXXZvFX6tLd|qZKI5pe3mf*o+gc6@4py=0e^FNgw(o|-{XF#ZQ=|Eu%> delta 4116 zcmbtX3vg7`8UD|?&%H@*_K|E72+3|9uz9T;poC}S6%|nk?*v51VA@h3OBPTb6Yhps zN?UDAuhY>^kpk1HXt5Jwu~hM6EXKdNuArstC#qQtOz5jDz8xo=TvEt01V|d zxq~CZ6VDNlD%HF<+K8W67PSw#A(0q);< z&?$sFqF|heDxesupBIPoA|WXyFviMASjv2Zj_inrI6qHJz2S(I!hhSil|+G5HnAi4NS6NcZU}BE_d?q$3BhI}Dj=q~c875M9y8unu{mK3UMfELg+n^6HUS}42Hpa;!(&-T8R%AHeQM5t27C%z@zo?R6D+kZ}TmD z&NnA~<`%-Q$>-c*#(TaA;jMg!K$UpwEBGAI!Xh5|7MhuAWdm9%E?&cPDtTP2lp4+} z)oPC_6{Xh0gGzjaNJzPr82qrM{LRv(${ku6U4;WdPl~@bp z78wakd{n;~R#B8|7{$(LVI2eLXBdd>)`;zf73T9(ab9}6QQ{0{n%cs|H(=|lsgdNq zqeP~1yLYUhPJ4qlytnK?kCmnx=e}g*J2=~{@}x%`4>%*L;&(&O82Jk{%!rSNoXI!X zaHdYA2{7DT$VBK_>3|GG`T0!~7tVm14i}Xr28fcdw5{r#bW*0Gxq;ZFnWAy zo;c)mBR(04qnoc?yLQ4ds-ZWy-R7uqZ=mYZjYPxoOv*5g(pjq$OWVG)N<8u=FAi=b zm(H0*zriUCl}hiOGX+fa8uX`J%`=3>+!{}wBbJGZAC6~v2QA@|5NO3tB%u@aX~HJ7 zsB+ZM>5me}sX{)?UpE4D0SP*N!FQ-Sm8mgZr^gk6mnH6$I6>mW5>HC}*x@4RX^Gdg zi<(Z~q-N7hSRl=1|L z+z&Jnz~sxHaFR!9S0s{$JvbJ zSnU|Fz&HR=%=ep@fbZ$&QE-2V!SZ~emcYM zVj5>OJFO+m9L}jREPS2RqZV?NPL>F*hwf%&+@M%#N>ibED4Evsp=Hq9Y3)3f@hl2q zgNnRn__8T3ward`ufZ^pqidK*K4%G|nHbs1^TEGs|D=f^mOX>=CT#c|(l#R$jTA+?#7w9Uc)WSs3 zmuZ_m2HqxKPp9Y&b0KreZT}L z!q&4MrY6NwyZKrnkLMef-E4vka5&wI#drOx!%|G0{nstK*%qwW+ilr0nV~RzKgeq@ zj$t9(%GW7hAE|dpDsDH#Cddlk76)^YB3GU~8 zxdpQn@0?Gresr#C!NjKz?%nsC$JpeqEetyihN1ZLZQnxF>rZ~)^fFc?1l3~xS|vob z7J~Yu#2$^fZQCYk3^zOF+G^zbS8#tj*Fu~X=I47E&-EvN1(yEX3SLB95Vo7CSbs-> zm&-7R6|r05ikNPJ&EJuQN(S|li0lrXVDfi}flO16F;S{wF*Cz3{4F--V4F7AZ50)_ zY9Z!twee=*wh`i{?Mv>$Y)m!8Y*RJhgVmqh?bx<1B1HnXP1DHrt>LzR9XJBaAPnkH z_7)hLZy~DeWNB~umhQmsGR3UYHtw;mN5PCfr0t%N=tn0DkTCZ%xn)I@9ofDt{bm+L z_c!C0iC;T@`F03xn#1kF6pG@T{mqz~f=A&q4dVV5^Z;uJ&&O79grWiHqXkS?Am-VD zM<8~sxQfIpc{UHub3ZQ{$ws*0;xKSh@gB^8w4u>hH0BNo{X?mZ*1CakWuZ(Wn)p-m zd14PXiZ#CtzsdMkob0xQ^Yqh@PKVu%;gUhU>(+N&nwoe2FW)@7yKK|Kp<+)>8vW4B zmbORYE8J7zQumW^tug{5oC=q?BTF)C(i!s?r!z22WSZN!<+qjp$$$PK|BFM%gCc!B z;I@|x#9!S{mQ?h;Tr!`zZ dd > div::after { +/* MAKES PARAMETERS MORE SPACIOUS */ +dl.parameters > dt > code { + padding: 3px; +} + +/* MAKES INHERITANCE LIST READABLE */ +:is(dl.typelist.inheritedMembers, dl.typelist.extensionMethods) > dd > div::after { content: none !important; } -:is(dl.typelist.derived, dl.typelist.extensionMethods) > dd > div { +:is(dl.typelist.inheritedMembers, dl.typelist.extensionMethods) > dd > div { display: block !important; } @@ -212,7 +217,7 @@ article[data-uid="Root.Landing"] img[alt="logo"] { } /* MAKES SIDEBAR LINKS A BIT MORE DISTINGUISHABLE */ -.affix ul li a { +.affix ul li a:not(.link-body-emphasis) { display: block !important; margin-left: 8px !important; } diff --git a/docs/_template/material/public/main.js b/docs/_template/material/public/main.js index 4bf8fd96a4..442fa9fd57 100644 --- a/docs/_template/material/public/main.js +++ b/docs/_template/material/public/main.js @@ -4,6 +4,11 @@ icon: 'github', href: 'https://github.com/discord-net/Discord.Net', title: 'GitHub' + }, + { + icon: 'discord', + href: 'https://discord.gg/dnet', + title: 'Discord' } ] } diff --git a/docs/docfx.json b/docs/docfx.json index 8fd342540a..71ae66bc2e 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -53,7 +53,7 @@ ], "postProcessors": [ "ExtractSearchIndex", - "DescriptionPostProcessor" + "DescriptionPostProcessor" ], "overwrite": "_overwrites/**/**.md", "globalMetadata": { @@ -63,6 +63,6 @@ "_appLogoPath": "marketing/logo/SVG/Logomark Purple.svg", "_appFaviconPath": "favicon.ico" }, - "xrefService": ["https://learn.microsoft.com/api/xref/query?uid={uid}"] + "xref": ["https://github.com/dotnet/docfx/raw/main/.xrefmap.json"] } }