Closed KevinMind closed 1 month ago
Most of our docs are documenting the API request and response so if those are readable (or can be reformatted to be readable) then we're pretty much there, imo.
@eviljeff I'm not sure I understand the A -> B of your comment. Are you suggesting that they are readable currently, and may not be with .md files? Or that they are not and would need to be made so? OR something totally different?
FYI I have another PR for adding swagger json/ui which may in fact make a lot of those docs obsolete .
@eviljeff I'm not sure I understand the A -> B of your comment. Are you suggesting that they are readable currently, and may not be with .md files? Or that they are not and would need to be made so? OR something totally different?
(i should have quoted) it was in reply to:
We may not be able to support all of the content formats we had in restructured as markdown does not support everything. See here for more details.
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-594
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-594
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-594
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-594
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-594
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-594
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-594
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-594
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-594
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-594
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-594
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-594
Old Jira Ticket: https://mozilla-hub.atlassian.net/browse/ADDSRV-594
Describe the problem and steps to reproduce it:
Convert our restructured markup to markdown syntax. Following this guide
Anything else we should know?
Migrating to using markdown will have several advantages.
There are a few downsides
┆Issue is synchronized with this Jira Task