SuiteCRM Documentation Guide Gets a Fresh New Look

A new way to navigate the SuiteCRM Online User Guide

We’ve refreshed the SuiteCRM Online User Guide to make navigation more intuitive, with a clearer structure and improved user interface.

What’s changed?

The guide now has:

  • Clearer sections for User, Administrator, Developer and Community documentation
  • Separate sections for SuiteCRM 7 and SuiteCRM 8, helping you find the documentation relevant to your version
  • Simpler navigation, with the page navigation moved to the left-hand side

Where are we going with it?

This new structure gives us a better foundation for continuing to improve the documentation and, over time, making it more version-specific. Our aim is to make it easier to find guidance that applies specifically to the version of SuiteCRM you’re using.

We’ll continue improving the structure and content of the guide, and we’d like the community to be part of that process.

Tell us what you think

Have a look around the new guide and let us know what you think in the comments below. We are interested in hearing whether the structure works for you, what could be improved, or what you’d like to see added.

Take a look at the updated guide: SuiteCRM Online User Guide

We’ve also put together guidelines for suggesting changes to the documentation if you’d like to contribute directly.

Your feedback will play an important part in how we continue to improve the guide.4

5 Likes

That looks pretty good, thank you! :partying_face:

It would be nice to fix the problems detected by htmltest that are displayed in the building log:

6:41:24 PM: 559 errors in 1027 documents
6:41:24 PM: ---------------------------------------------------------
6:41:24 PM: 1
6:41:24 PM: 118 hash does not exist
6:41:24 PM: 440 target does not exist
6:41:24 PM: 1 hash does not exist

1 Like

Nice! much cleaner and easier to read!

@suitecrm_team
There is some information missing, or did this information get moved somewhere else?

Here:

the docs of the JSON API endpoints:

on the old version:

I still see the POST body:

So with the new version it’s impossible to create a relationship - the API will just throw an error.

Thanks everyone for the feedback on the new guide.

We have applied an update to address the issues raised, including fixing broken links and anchors (thanks @likhobory) and restoring the missing relationship endpoint details, including the POST body, in the V8 API docs (thanks @BastianHammer).

If you spot anything else that’s missing or not working, please let us know here or suggest a change directly using the documentation contribution guidelines.

1 Like

Thank you, Team! :100: :partying_face: