Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
VTK
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Michael Migliore
VTK
Commits
0dddc427
Unverified
Commit
0dddc427
authored
1 year ago
by
Christos Tsolakis
Committed by
Jean-Christophe Fillion-Robin
1 year ago
Browse files
Options
Downloads
Patches
Plain Diff
Add release note
Co-authored-by:
Jean-Christophe Fillion-Robin
<
jchris.fillionr@kitware.com
>
parent
cc20328b
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
Documentation/release/dev/docs-updated-and-consolidated-with-new-websites.md
+45
-0
45 additions, 0 deletions
...se/dev/docs-updated-and-consolidated-with-new-websites.md
with
45 additions
and
0 deletions
Documentation/release/dev/docs-updated-and-consolidated-with-new-websites.md
0 → 100644
+
45
−
0
View file @
0dddc427
## Updated and Consolidated Documentation
### Overview
The VTK (Visualization Toolkit) documentation has undergone a major update and
consolidation to enhance its usefulness for developers. The
`/Documentation/docs`
directory now contains the contents and configuration for
the Sphinx-based website, published on the ReadTheDocs platform at
https://docs.vtk.org. This consolidates all existing documentation for VTK,
including the newly added list of supported data formats, API of all VTK public
CMake modules, the VTK formats specification (previously part of vtk-examples),
and the general information about the VTK project. Software process and
conventions documentation has also been moved from docs.google.com to the new
website.
In addition to the documentation website, two new resources have been
introduced: the VTK book, which hosts the markdown version of the VTK book at
https://book.vtk.org and VTK examples at https://examples.vtk.org, which
contain many examples with redirects put in place to ensure the previous URL
remains functional. Many other updates to the documentation have also been
made, including improved documentation structure, removal of obsolete
documents, and addition of imported third-party projects to the developer
guide. VTK documentation now follows a versioning system and is actively
maintained alongside the code.
Contributions and feedback are welcome for all three websites to ensure that
the VTK documentation remains up-to-date.
### Next steps
The next steps for the VTK documentation project include setting up a
versioning system for docs, doxygen, and the book. Work is also underway to
include a description of each
`Modules`
(as well as a
`README.md`
file) in
`docs.vtk.org`
. And there are plans to explore the possibility of using merge
request previews for the documentation so that contributors don't have to
compile it themselves.
For
`examples.vtk.org`
, the plan is to consolidate examples from VTK and
`vtk-examples`
.
Pages on the
`mediawiki`
site will be marked as deprecated, and a link to
`docs.vtk.org`
will be included.
These efforts will help ensure that VTK documentation remains user-friendly and
accessible to all developers.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment