Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

reference fusion docs #15562

Merged
merged 1 commit into from
Oct 14, 2020
Merged

Conversation

timotheecour
Copy link
Member

@timotheecour timotheecour commented Oct 13, 2020

followup after nim-lang/fusion#24 (EDIT)

pending nim-lang/fusion#26 to make the link valid

fixes https://forum.nim-lang.org/t/6904

@Araq Araq merged commit 0c0f86b into nim-lang:devel Oct 14, 2020
@@ -132,7 +132,10 @@ doc.body_toc_group = """
<a href="$theindexhref">Index</a>
</li>
<li>
<a href="compiler/$theindexhref">Compiler docs</a>
<a href="compiler/$theindexhref">compiler docs</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the change of case here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's for consistency with import compiler/foo (instead of import Compiler/foo), ditto with import fusion/bar instead of import Fusion/bar

I don't care much either way here.

still though, I would've preferred to get nim-lang/fusion#26 merged first as indicated in top post to make sure the link is valid

@timotheecour timotheecour deleted the pr_doc_fusion_reference branch October 14, 2020 07:42
@alaviss
Copy link
Collaborator

alaviss commented Oct 15, 2020

Can we have this reverted until nim-lang/fusion#26 actually got merged? Also the link is very misleading. It would always refer to the latest devel docs, while the installed/bundled version might be different.

@alaviss
Copy link
Collaborator

alaviss commented Oct 15, 2020

Note that fusion docs are actually built and is in the stdlib theindex.html. The fix to get this out fast is to modify kochdocs to build lib/fusion as a separate project.

@timotheecour
Copy link
Member Author

Can we have this reverted until nim-lang/fusion#26 actually got merged?

it got merged finally

the link is very misleading. It would always refer to the latest devel docs, while the installed/bundled version might be different.

we can change the link to fusion docs (master)

Note that fusion docs are actually built and is in the stdlib theindex.html. The fix to get this out fast is to modify kochdocs to build lib/fusion as a separate project.

indeed, https://nim-lang.github.io/Nim/filepermissions.html is generated and should not be (at least not at that url).
That's a consequence of copying fusion into Nim/lib/fusion, which as I stated in nim-lang/fusion#25 needs to be revisited or properly thought through, but we can improve things in the meantime.

see nim-lang/RFCs#265 for a proposal on how to publish versioned docs for nim + fusion

mildred pushed a commit to mildred/Nim that referenced this pull request Jan 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants