search

algorandfoundation / xgovw

Mozilla Public License 2.0
3 stars 3 forks source link

Linking/adding more documents to xGov #1

Closed mpetruska closed 1 year ago

mpetruska commented 1 year ago

IMHO the xGov validator needs some changes. It does not accept non-relative links, but adding any file that is not an xGov proposal also fails. This makes it that there does not seem to be a way to link/add additional docs. Also this issue seems to only come up when it is ran in a GitHub workflow, the standalone version does not report any issues: https://github.com/algorandfoundation/xGov/pull/18.

mpetruska commented 1 year ago

Sorry, the error does get reported, my bad:

[nix-shell:~/Algorand/GitHub/xgovw]$ cargo run ~/Algorand/GitHub/xGov/Proposals/xgov-18.md
    Finished dev [unoptimized + debuginfo] target(s) in 0.53s
     Running `target/debug/xgovw /home/mark/Algorand/GitHub/xGov/Proposals/xgov-18.md`
error[markdown-rel-links]: non-relative link or image
  --> /home/mark/Algorand/GitHub/xGov/Proposals/xgov-18.md
   |
14 | the library can be found here: [coq-avm-introduction.pdf][1]
   |
validation failed with 1 errors :(

[nix-shell:~/Algorand/GitHub/xgovw]$

Still, is there a way to link documents?

mpetruska commented 1 year ago

Okay, by examining the code, it turns out linking of external documents can be done with the use of the a (html) tag. e.g. <a href="https://drive.google.com/file/d/1lafzfhvD-R5va4YQjO-yxfwnHskgCC0a/view">coq-avm-introduction.pdf</a>