Skip to content

Conversation

@wabjnr
Copy link
Contributor

@wabjnr wabjnr commented Sep 5, 2025

Documentation? Who needs it?

Moving the main docs directly to the Dev Portal.

Documentation? Who needs it? 

Moving the main docs directly to the Dev Portal.
@wabjnr wabjnr self-assigned this Sep 5, 2025
@predikament predikament added the documentation Improvements or additions to documentation label Sep 5, 2025
Copy link
Collaborator

@predikament predikament left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a small code example should still be here, at a minimum;
This would leave any users of the library able to understand it on a superficial level at the very least, then if they want more documentation they can find those externally.

Also I would rather update this to include the new external docs link once we have that ready, instead of updating it now to remove everything and leaving users without a place to find this info in the interim.

Updated to include the link to the Dev Portal for more detailed docs and usage examples, as well as a tag for inserting the detailed docs in said dev portal.
@guilleccc
Copy link
Collaborator

Just keep in mind @wabjnr that the dev portal documentation is not public, so normal github users won't be able to access it: https://devportal.noriginmedia.com/docs/Norigin-Spatial-Navigation/

@wabjnr
Copy link
Contributor Author

wabjnr commented Sep 8, 2025

@guilleccc the Spatial Navigation page, amongst others, is now public, so I have linked to it.

Copy link
Collaborator

@predikament predikament left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is OK, but I would still prefer a small concrete usage example to be included here in addition to the external documentation.

Let's see how we can best solve that later then.

@wabjnr wabjnr merged commit a668d62 into main Sep 8, 2025
1 check passed
@wabjnr wabjnr deleted the wabjnr-patch-1 branch September 8, 2025 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants