Hi. I was invited here by <@U01GCJKA8P9> as we're ...
# design-datahub-documentation
a
Hi. I was invited here by @big-carpet-38439 as we're trying to introduce DataHub into our company and we have some specific requirements for structuring, editing and displaying documentation for datasets. We're in the process of more formally gathering these but is this a good place to talk about them? Sorry if we're late to the party!
a
Hi Matt! I think it’s a good place to talk shop on documentation! Any specific questions you have?
b
+1 - we’d love to hear those as we shape the new documentation experience. Let us know!
a
Hey guys. Sorry, I was just collating some of these with some of our developers and these are our main thoughts so far. Improved Editing It's important for us for non-skilled analysts to be able to manually add/edit documentation without needing to know much about markdown. They currently use Confluence for knowledge sharing so they want to match as many features as possible. In particular they want to see: • WYSIWYG documentation editing • Easy ways to add images to pages • Easy editing of tables Structured Documentation with Navigation Creating a large, structured document is possible using headers, but larger documents need a table of contents or a navigation bar (example?) to help users quickly find the information they need. It would also be nice for new entities to have customisable documentation templates to fill in when populating it for the first time.
a
@big-carpet-38439 Any thoughts, these are some great feature ideas!
b
It sounds like comments are also a request (nice-to-have), but possibly not strongly required
b
The Grab team has built for these: • WYSIWYG documentation editing • Easy editing of tables Document templating is a good one. Both image upload & document templating are in our radar for 2023H1. But let us know if your team would like to collaborate w/ us teamwork @astonishing-answer-96712 cc @brave-insurance-80044