search

flintlib / flint

FLINT (Fast Library for Number Theory)
http://www.flintlib.org
GNU Lesser General Public License v3.0
422 stars 239 forks source link

Add more documentation links #996

Closed wbhart closed 10 months ago

wbhart commented 2 years ago

W Stein writes:

I would humbly suggest that the FLINT landing page have a link at the top to

http://flintlib.org/doc/

The FLINT website begins "FLINT is extensively documented" (very true!); however, as far as I can tell, there's no link to the docs or other mention of documentation anywhere on the website, except in the downloads section (http://www.flintlib.org/downloads.html). This is a possibly surprising place to find docs, since they aren't something you download anymore (it used to be that they were, when they were only available in pdf).

Also the page http://www.flintlib.org/features.html is kind of like the table of contents of a reference manual of FLINT functionality, except (1) there is no link to the documentation on that page, and (2) there are no links from any of the features listed there either. For a while I thought I should just get inspired by http://www.flintlib.org/features.html, then dive into the source code to figure out how to use something, which is how some projects are that are too busy to write proper docs.

albinahlback commented 2 years ago

Just reminding that a PR has been merged (https://github.com/wbhart/flintwebpage/pull/1). Think the site needs to reload, but maybe my browser is displaying the site incorrectly.

wbhart commented 2 years ago

I think the issue is that the website is no longer hosted from a git repository. I guess it has to be changed on the actual website.

I'll try to look into that.

On Fri, 10 Sept 2021 at 22:30, Albin Ahlbäck @.***> wrote:

Just reminding that a PR has been merged (wbhart/flintwebpage#1 https://github.com/wbhart/flintwebpage/pull/1). Think the site needs to reload, but maybe my browser is displaying the site incorrectly.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/wbhart/flint2/issues/996#issuecomment-917192581, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAB3HJRKBJVL77CKJNOH3LDUBJTF5ANCNFSM5DZ7KKCQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

wbhart commented 2 years ago

I've now added doc links on the features and index page. I'll leave this ticket open though, as it may still be nice to make some of the titles on the features page into links, as William kind of suggests. I don't have time to do it right now.

wbhart commented 2 years ago

I've added links to the source code for each module. Now that I've done it I realise I probably should have added doc links instead. The links I added were to @fredrik-johansson 's repo since that will become the canonical one eventually.

Anyway, I will now push this ticket to 2.10 so someone can add arb and antic links and maybe switch to doc links if that is preferred.

albinahlback commented 10 months ago

I see this as completed. There is a link at the top of https://flintlib.org/, and there is a link in the README as well, wihch I think is "lagom". Feel free to reopen if you disagree.