From 7392b0eb9808da787ee4b86453f4bbbe4ee369f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20M=C3=BCller?= Date: Tue, 24 Mar 2026 17:59:47 +0100 Subject: [PATCH] Added DocFX --- .gitea/workflows/release-build.yml | 10 +++++ CHANGELOG.md | 1 + docs/docfx.json | 61 ++++++++++++++++++++++++++++ docs/images/favicon.ico | Bin 0 -> 67646 bytes docs/images/icon.png | Bin 0 -> 978 bytes docs/index.md | 22 ++++++++++ docs/templates/amwd/public/main.css | 3 ++ docs/toc.yml | 4 ++ src/LinkMobility/README.md | 4 +- 9 files changed, 103 insertions(+), 2 deletions(-) create mode 100644 docs/docfx.json create mode 100644 docs/images/favicon.ico create mode 100644 docs/images/icon.png create mode 100644 docs/index.md create mode 100644 docs/templates/amwd/public/main.css create mode 100644 docs/toc.yml diff --git a/.gitea/workflows/release-build.yml b/.gitea/workflows/release-build.yml index 9f10513..7c739eb 100644 --- a/.gitea/workflows/release-build.yml +++ b/.gitea/workflows/release-build.yml @@ -58,3 +58,13 @@ jobs: run: | set -ex dotnet nuget push -k "${{ secrets.NUGET_APIKEY }}" -s "https://api.nuget.org/v3/index.json" --skip-duplicate /artifacts/*.nupkg + + - name: Publish documentation + env: + DOCFX_SOURCE_REPOSITORY_URL: 'https://github.com/AM-WD/LinkMobility' + run: | + set -ex + /dotnet-tools/docfx metadata docs/docfx.json + /dotnet-tools/docfx build docs/docfx.json + tar -C "${{ gitea.workspace }}/docs/_site" -czf "/artifacts/docs.tar.gz" . + curl -sSL --no-progress-meter --user "${{ secrets.DOCS_DEPLOY_USER }}:${{ secrets.DOCS_DEPLOY_PASS }}" -F docs=linkmobility -F dump=@/artifacts/docs.tar.gz "${{ vars.DOCS_DEPLOY_URL }}" diff --git a/CHANGELOG.md b/CHANGELOG.md index efd64c7..8ad286d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - `Validation` utility class for specifications as MSISDN +- Docs rendering using DocFX ### Changed diff --git a/docs/docfx.json b/docs/docfx.json new file mode 100644 index 0000000..df8eef4 --- /dev/null +++ b/docs/docfx.json @@ -0,0 +1,61 @@ +{ + "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json", + "metadata": [ + { + "src": [ + { + "src": "../", + "files": [ + "src/LinkMobility/bin/Release/netstandard2.0/amwd-linkmobility.dll" + ] + } + ], + "dest": "api", + "outputFormat": "apiPage" + } + ], + "build": { + "content": [ + { + "files": [ "**/*.{md,yml}" ], + "exclude": [ "_site/**", "obj/**" ] + } + ], + "resource": [ + { + "files": [ "images/**" ], + "exclude": [ "_site/**", "obj/**" ] + } + ], + "output": "_site", + "template": [ "default", "modern", "templates/amwd" ], + "postProcessors": ["ExtractSearchIndex"], + "globalMetadata": { + "_appName": "LINK Mobility REST API for .NET", + "_appTitle": "LINK Mobility REST API for .NET", + "_appFooter": "© AM.WD — Docs generated using docfx.", + "_appLogoPath": "images/icon.png", + "_appFaviconPath": "images/favicon.ico", + "_disableBreadcrumb": true, + "_disableContribution": true, + "_enableSearch": true, + "_enableNewTab": true, + "pdf": false + }, + "markdownEngineName": "markdig", + "markdownEngineProperties": { + "alerts": { + "TODO": "alert alert-secondary" + } + }, + "sitemap": { + "baseUrl": "https://docs.am-wd.de/linkmobility", + "priority": 0.5, + "changefreq": "weekly" + }, + "noLangKeyword": false, + "keepFileLink": false, + "cleanupCacheHistory": false, + "disableGitFeatures": true + } +} \ No newline at end of file diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..a7eeff702474e348a883683356c713024ea32270 GIT binary patch literal 67646 zcmeI53yd9Q6~}K&>9$q7V6nkg-3^K@ibNAlTD2|#HHZ+R5GbX#nt&uIh}wv#xC@HJ z1dR_6w3TWt_@Y33phgUpn1EFfi}6{@^^vH6h*6-0rS$Rw*MNex43T^vo1dMMC}vcs)aDK7 zMzj}YsdLgkcj5n?=&%_D*wbXG!xHo@l(c@X+UakG#(kxyXr{s<#-q_1bPjqqx(J&tyuc@X#Ip)*LVrcQ@_Lf(zd_s3rDz4>DRh5diVtl; zz49u1n?4V;-}uZb$uYk6e>S5$`D@N7mt|Gv(rxT0wmkV2*;k)O=XZ;}$n}hS2>Ly8 zmES&meFq(1WZY?d6U)U8^K-?ilOG*#^6eevyclaX`fh=2eu?k3sItEejD326`E{yc z-gP^P_lPoP0ORO9N8Wgo^uLpFURFj<@i7?lV03>;IVRzdw9UiBd_p{zB9;V^U4QYp10CM$eVlb0 zem5XjHK^K;j?WflWznf0{+{6ppT7~u%1$xnS%=RXJju`1+|e~gr^iwF`?V*G{zDwE z&QtI9zWCGmNmuNB@pEQ-o_TEeT;mZVr*nY3c6*eYtNEjx=H{t+yf40dJ2#>^uqqy7 z)@A(s47uX&lb;K-GHLGzpLyu-o^jGK=`roGrnT|$eb4f8HHRJ|uZ3xObZd{V4|vE) z`@6Yvr2keA^Kvx@)^w|9+VwEf^`C!x$ZA{KT;lD?NB48N;_aKCjqzObF2iY!r>x$S zH8=8EigYc~x7xXgXIEA(-TJ|4qlc`tFOd2C5Pfys$pvp8eLSyQEwikLlkRQ5&qH3H z%aV`!kjr~L%*WMSTAP(iw|=lX3RQ7Us23C6YnJK!H~mIYFW+_Ec5b&i=2;J~bsjRi zA!||TX*-q~diX?@+DC3f{8?sF@SJ#DW2+Hc6pB5ObR9f|%>A;+CLV)yMj zXTSRP+di6=MV@}tei6DJRk2TSPuAFp_jRZr)4FWWydRX6Uwc1T>Ulps(_ALA%iH5f zY7^(nOOCZDF1yI%=}Gf0vK?{gdCIk@-?O5wSY*B@fEb^TT*Xn9pGk6XexGFCIYLYe z&}HZ`R1}+A^2AA8M-&)aQ8~x`>RFKU@-Qg6FY!GWZ9%T*!9DoQ^-LuF*P%GiIxUN5 z;pci>%@5TIorZM(b>90*bPv~(ys_b9GpbX~Td_Vs+$-|tUsZo%*E44Njvbv#)^lI2 zy!!ptd;UaMapUX$6l3>`t&HtY67SXMS*{pV?T1`uBb`S&8)<*xOXwD)&xuXwljuy8 z`F@X1IpS|QDx+qu#<+=i?K{Id6*J{JIO-VXM>VLwp85X}vbv|Naj)j^^zpp!KZ)xn zNPiPAL|%ShPA{%?*alY}kL2C|Z2wHx{@CqEf1A%kZ$_t}laTgvUXPAP$D&neC3*#V zDLNW0t^>Qe#|Y=8Xa{PqUmE*S`hOL@1F4<^voBWn`u2*SIvt179Bahq#8dRW4XsCB zoM-Kot8F_#fO_fp;{9k6#cP^$S;r$w4|uetIuM{{hocXoCQ4fCc)LH-uki0$ssqb9 z#7M1leo^~WZ$n>4PoQ``lP>ET_UBQq=M3w>%*Pnvz5wZb&|8r1&(i1bjp!@U@^$>) zguZ~TMf%?4-AHvyTH{{rO23E3$2yc96SW&cA43m2s$;JjciXn5?7VHf;66Nkc5DB- zTV2Xnuj9gbR*&)t!2ObnYp?m`?7C9<1nWH_?5qAxCjHHE`hOSTZwb;lzq62@H@y;V zMYp1xqvg-=TjzRDMlVA1>s`rg(UbR|P#K@`-NyK0w#cXVB8O#2`!M%r%t!mMze1ly zr=l70|H6>x?WkLA%2=Q4`_qX1IY`GOlaBMyeE0==AA0um*)}*9xt)W`sB^b5)@P+j z+$SJi6X@pK)q2gX@1fPGuz(g{JyaZvcyl!y0*6$xvFteKf4%n9XcpW z+&=ap7u_3}G=JCaE=kLTSm&TWRv5Dw{1z4VymwkAdE1lACo1CkjkK{7=h}*5?KJm) zKr91sjfy-zUIABqhNt=-ZQ5U6L7bgx-&&{tE9$JY^VrAsi7PjLh^Sv((3u3#VQ*RxqhzE<$QR6_y*?QVsg>FA=)?8z49(OwS3*0rv7S69J&v<)!)b87pKk1 z_xA9fk95v>r(^bKXUUxysyJRrI@f-hC8xUdf&H=QCY1Nu%We3`eE$c1_3WbV6Hi)~ zvfAkyQmS(sb*X(kPI6p~bPie9)OF1)X)ScE_9B$~+B-g8gPN$U+9n<6&^W7^uuKhx z(TV6INOR&Ev=MDaThXQHDAz3Tsd2AINo!MdyS=V+G=KdGP=Ed38IO1{55C+#T5C}R z0cx*jP_%ET3m%^BT8_>#J@nMv_dpF`0b(G}_unipH-cRX0l0;fo_a-x1)sADrg_H91Ho1RIn7cCukS9x5sRi zN&~jG%T}r_djwkpj7R>*u$58E9+%xzU1-EhCb^PUUY9|lr88J*iH2x3EHzf97Nf&_mPRBY_(UbAb_#3 ieeknwdoaLwY`Yx9OgV@qP_$N~PJ8X0W|`puf&T%o8TIJ^ literal 0 HcmV?d00001 diff --git a/docs/images/icon.png b/docs/images/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..a95e56e216fb72b96184028dba75f53e2f04addc GIT binary patch literal 978 zcmV;@11500001b5ch_0Itp) z=>Px#1ZP1_K>z@;j|==^1poj532;bRa{vGf6951U69E94oEQKA17}G@K~z{r?UhYv zTvZr`pKs>QBqb65nx>k+rqKG6ZVCZg(8WkHiAqZsZUi?~!B$YzO%YLu3pauiTu7t_ z-KgloQcBA>=|sT@N`eHd4N*xtlQddwBc;VQx%Yf7X6ELe+nMPNW+TkAn)iLbb9v{? znRB5|ojU)2^%nBCiu@~#uqnp?fRXldx=MP z{uz!reZC9hy$cKiiEs>n>I%?Hy7R|aIJ+rh`8Klo*T@!r#`P}XBxZ0Lm&g`|thsD{ z5aUh*`>GZJ5J`gU0Ek{@WHLdv@DfIT0eJ(s52U!WB5`1kKRfnYE6V2}w+5b28PypQ z?nxq-nbZW^w~PXBBWw!CMdV}uqnGSKq}hrqqLY~GX;R(Sh+JlQ;V{UPVcWtp6Klfx z4)oh#?4xQxr!o2r%N=_d+)*e;(GGC7FbW(D+cvU~{`M2T93OWuJ0Hf=y`U|KUIAty zK1Sc&3y2tNdE_!D=C;xhe-Y>gK&1iEdqD0DOr7DMSc?5^e+9gC5v@!$vU9t^c^~Kn zK=}jVb)4jJzS?qup&P$_EuxkAOyji7Cz!qH@oev^l^r{K3r)?_{;m~S0WPBY6UbFi z7m*cI=Rv+9;pWPRHc0g{szPpYFP?cEcnqZUyUQmy?XQv&*PqQ6UI2!z^|hHt^$_XK zOwg=cCX?TV$Xf`5;i$yR^mn}DtIWAHv6%JX2&`augn^D+*|7iGszNsZ6v9-EBB1QD zw8U?-bTpF0?A^4>j4d2NIa<7;YamS9T2q#eifRwXXEvARTA9;}X;j}tN>_X}RDZ`w zj{5rKYy-*xYbGiphTAuJWmznfS!%+V4pu;%7K97h7gS9hqYHl0x z*wY}}K$j4va7>0&_us(<6&asvWYzfq^og41PWb`!mGEU(ruxG5BYatS0Q4Xty(q1q z9*{?wLgZ5>j(*S3(7N7N8-wabe$hI0>a2@@0mH^3Bp(b{a{vGU07*qoM6N<$f|oSH AegFUf literal 0 HcmV?d00001 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..c95c8b0 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,22 @@ +--- +_layout: landing +--- + +# LINK Mobility API + +[LINK Mobility] is a company specialized in customer communication. + +The available channels are SMS, RCS and WhatsApp Business. + +## NuGet packages + +Here is an overview of the latest package. + +| Package URL | Version | Short Description | +|-------------|---------|-------------------| +| [AMWD.Net.Api.LinkMobility] | ![NuGet Version](https://img.shields.io/nuget/v/AMWD.Net.Api.LinkMobility?style=flat-square&logo=nuget) | Package contains the interfaces to handle the API. | + + + +[LINK Mobility]: https://linkmobility.eu +[AMWD.Net.Api.LinkMobility]: https://www.nuget.org/packages/AMWD.Net.Api.LinkMobility diff --git a/docs/templates/amwd/public/main.css b/docs/templates/amwd/public/main.css new file mode 100644 index 0000000..c152c69 --- /dev/null +++ b/docs/templates/amwd/public/main.css @@ -0,0 +1,3 @@ +#logo { + margin-right: 8px; +} \ No newline at end of file diff --git a/docs/toc.yml b/docs/toc.yml new file mode 100644 index 0000000..e9e4b3e --- /dev/null +++ b/docs/toc.yml @@ -0,0 +1,4 @@ +- name: API + href: api/ +- name: GitHub + href: https://github.com/AM-WD/LinkMobility diff --git a/src/LinkMobility/README.md b/src/LinkMobility/README.md index d0984c7..1a0bd52 100644 --- a/src/LinkMobility/README.md +++ b/src/LinkMobility/README.md @@ -12,7 +12,7 @@ In this project the REST API of LINK Mobility will be implemented. --- -Published under MIT License (see [**tl;dr**Legal]) +Published under MIT License (see [choose a license]) [LINK Mobility REST API]: https://developer.linkmobility.eu/ -[**tl;dr**Legal]: https://www.tldrlegal.com/license/mit-license +[choose a license]: https://choosealicense.com/licenses/mit/