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

Removing outdated documentation that is missleading for CV32E20 #145

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 0 additions & 67 deletions doc/01_overview/compliance.rst

This file was deleted.

16 changes: 0 additions & 16 deletions doc/01_overview/index.rst

This file was deleted.

16 changes: 0 additions & 16 deletions doc/01_overview/licensing.rst

This file was deleted.

19 changes: 0 additions & 19 deletions doc/01_overview/targets.rst

This file was deleted.

File renamed without changes.
73 changes: 0 additions & 73 deletions doc/04_developer/concierge.rst

This file was deleted.

18 changes: 0 additions & 18 deletions doc/04_developer/index.rst

This file was deleted.

14 changes: 3 additions & 11 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,21 @@ The CPU core is based on the Ibex core, but simplified and verified under the Op
You are now reading the CV32E20 documentation.
The documentation is split into multiple parts.

The :doc:`Technical Specification <00_specification/index>` Contains the technical specification of CV32E20.
The :doc:`Technical Specification <01_specification/index>` contains the technical specification of CV32E20.
It defines the supported features in the form of requirements.

The remaining parts of documentation are inherited from the Ibex project. They are kept for reference and will be reworked in the future.

The :doc:`Overview documentation <01_overview/index>` looks at Ibex from high up.
It answers questions like what are the high-level properties of Ibex, which standards is Ibex following, and where is it typically used.

The :doc:`User Guide <02_user/index>` provides all necessary information to use Ibex.
It is aimed at hardware developers integrating Ibex into a design, and software developers writing software running on Ibex.

The :doc:`Reference Guide <03_reference/index>` provides background information.
It describes the design in detail, discusses the verification approach and the resulting testbench structures, and generally helps to understand Ibex in depth.

The :doc:`Developer Guide <04_developer/index>` is aimed at people making changes to Ibex itself.
Since Ibex is open source, every user of Ibex is encouraged to learn how to adapt Ibex to their use case, and be part of the open development process.

.. toctree::
:maxdepth: 2
:maxdepth: 3
:hidden:

00_specification/index.rst
01_overview/index.rst
01_specification/index.rst
02_user/index.rst
03_reference/index.rst
04_developer/index.rst
Loading