Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

resolves #648 refresh documentation #649

Merged

Conversation

sturtison
Copy link
Contributor

@sturtison sturtison commented May 31, 2023

Will squash and rebase on main before final.
Full notes on issue #648

@sturtison sturtison force-pushed the docs/issue-648-refresh-docs-draft branch 2 times, most recently from 8b6ee54 to 0802ae8 Compare June 6, 2023 18:43
@sturtison sturtison marked this pull request as ready for review June 6, 2023 18:44
@sturtison
Copy link
Contributor Author

It's ready for review and any further changes. #648

README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
@ggrossetie
Copy link
Member

That's pretty good thanks! 👍🏻
I left a few comments/nitpicks.

@sturtison
Copy link
Contributor Author

I added back the usage section and moved next steps to the top.
Plus some other changes at the top, with the idea of speed and usefulness fast.
This includes a little "mini horizontal menu"

@sturtison sturtison force-pushed the docs/issue-648-refresh-docs-draft branch from 68ffcf3 to a541e31 Compare June 7, 2023 05:06
@sturtison
Copy link
Contributor Author

Ready for review and any further changes.

@sturtison sturtison force-pushed the docs/issue-648-refresh-docs-draft branch 2 times, most recently from f4e2eb6 to ec07b54 Compare June 7, 2023 05:23
@sturtison
Copy link
Contributor Author

Niggles, dictionary lists separated, and last typos fixed after a re-read.

@sturtison
Copy link
Contributor Author

Ready for review and further changes.

@sturtison sturtison force-pushed the docs/issue-648-refresh-docs-draft branch from ec07b54 to cdfa2a3 Compare June 7, 2023 05:44
@sturtison
Copy link
Contributor Author

Applied the same conventions to the local installation section.
No further changes from my side. Will note them in the review if I find something.
Squashed and rebased on main.
Ready for review and further changes.

CONTRIBUTING.adoc Outdated Show resolved Hide resolved
CONTRIBUTING.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
README.adoc Outdated Show resolved Hide resolved
:source-language: asciidoc

The main feature is viewing AsciiDoc as HTML5 directly in the browser.
Other features cover where those AsciiDoc files are located, and how they are rendered.
Copy link
Member

Choose a reason for hiding this comment

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

I don't know what you mean by "where those AsciiDoc files are located"?

I would say something like: "Other features include automatic reload, built-in and custom themes, AsciiDoc attributes as query parameters, diagrams using Kroki and more."


== Auto reload

If the content of the page is changed, the rendered view is automatically refreshed.
Copy link
Member

Choose a reason for hiding this comment

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

That's partially true, the extension will periodically poll for changes and reload/refresh the preview if the content changed.

@ggrossetie ggrossetie merged commit fb698cb into asciidoctor:main Jun 26, 2023
3 of 4 checks passed
@ggrossetie
Copy link
Member

And we are live https://docs.asciidoctor.org/browser-extension/latest/ 🎉 🎉 🎉

Many thanks @sturtison for your work 🤗

@sturtison
Copy link
Contributor Author

Awesome! Thanks for your patience, help and guidance 👍

@sturtison sturtison deleted the docs/issue-648-refresh-docs-draft branch June 27, 2023 08:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants