Updating the documentation guides!

[zlovatt]

Hey all!

We're making a broad movement to transition all of the self-hosted scripting docs (those living under subdomains of https://docsforadobe.dev) from Read the Docs over to Github Pages, built using MkDocs & themed with Material for MkDocs.

Why?

This change brings a few benefits, namely:

• Transitioning from reStructuredText (.rst) to Markdown (.md)
• Modernizing & improving the user experience, navigation, and search features
• Simplifying (future) updates & css changes
• Allowing the docs to be more easily viewed & read locally (via the markdown files) vs requiring to be built, as markdown readers are more plentiful.

This process is being done fairly manually, and so will take time; docs are currently being converted one at a time.

Helping Convert

The current workflow repeats a lot of pages & files between every repo. Eventually it would be nice to standardize & centralize these elements (shared css, template files, settings, etc) though any input on how best to achieve this would be appreciated!

If you're interested in helping convert a repo, take a look at our page on Converting .rst docs to .md.

Contributing to the Documentation

If you're more interested in contributing to the documentation itself for a given project, see the Documentation Contribution Guide.

Questions, Comments, Concerns?

We've opened up this discussion board for general, org-wide conversation. Please open a new thread!

Important

If you have an issue with a specific documentation guide, please use that guide's repo instead of this discussion board, as this is intended for broad, organization-wide conversation.