Make it possible to link directly to a section like "Current Status"

[mithro]

All the headers should have ids so that you can link directly to it. For example the "Current status" section.

[mithro]

@umarcor - This should be pretty easy right?

[umarcor]

We are in the process of moving the "status" (supported architectures and boards) to the Sphinx documentation (chipsalliance/f4pga#531 and #5), so we can partially autogenerate/autoupdate the content based on the results from tests, etc. and complement it with info from hdl/containers, openFPGALoader, etc. (which use Sphinx already). See https://f4pga.readthedocs.io/en/latest/status.html.

For now, the table does not look as nice as the website; however, the links to each section are autogenerated and shown by Sphinx already:

• https://f4pga.readthedocs.io/en/latest/status.html#bitstream-documentation
• https://f4pga.readthedocs.io/en/latest/status.html#boards

Furthermore, we can cross-reference the sections from other Sphinx sites, through intersphinx.

From a technical point of view, using Sphinx also makes it easier to update the content, because it's a Python list of lists + tabulate (see https://github.com/chipsalliance/f4pga/blob/main/docs/conf.py#L15-L33), instead of plain HTML.

[mithro]

@umarcor - I think you keyed on the wrong point here. This topic was just about making sure that sections in the website have a way to be linked to directly. IE "What's New", "Why F4PGA?", "How it works", "F4PGA project structure", etc.

[umarcor]

The point is that it's proposed to remove "How it works", "Project structure", "Start using" and "Contribute now" from the website (#5), and have them in the documentation. I.e., to link from the website to the sections in the documentation, instead of having the content duplicated (and out of sync) in both sites. See:

• https://f4pga--533.org.readthedocs.build/en/533/
• https://f4pga--533.org.readthedocs.build/en/533/how.html
• https://f4pga--533.org.readthedocs.build/en/533/getting-started.html
• https://f4pga--533.org.readthedocs.build/en/533/community.html#contributing

With regard to others, the HTML section id can be used:

• "What's New": https://f4pga.org/#news
• "Why F4PGA?": https://f4pga.org/#about

[mithro]

So it looks like the <h3> are missing an ID?

[mithro]

It looks like <h2> are also missing an ID.

[umarcor]

Actually, all <h2> are located right at the beginning of a section.
For <h3>, there are https://f4pga.org/#eda-ecosystem and https://f4pga.org/#structure.
Thus, the only missing direct link is "Current Status".

However, I would refrain from advertising #eda-ecosystem, #structure or #status, and I would promote the sections in the docs instead.