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.

Sign up for GitHub

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

Jump to bottom

April 2023 newsletter #213

Merged
merged 19 commits into from
Apr 7, 2023
Merged

April 2023 newsletter #213

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift click to select a range
411a6fd
WIP: April 2023 newsletter draft
benjaoming Mar 7, 2023
e3c2712
WIP: Newsletter items hatching...
benjaoming Mar 30, 2023
d60aead
Add news about other 3 Git env vars
benjaoming Mar 30, 2023
42a9560
Merge branch 'main' of github.com:readthedocs/blog into newsletter-ap…
benjaoming Apr 4, 2023
0b24da5
Add twitter thread, update language and list item order
benjaoming Apr 4, 2023
4336790
Use Newsletter category
benjaoming Apr 4, 2023
20ce8bc
Add more context to the update about our docs structure
benjaoming Apr 4, 2023
a98db49
gathered=>integrated
benjaoming Apr 4, 2023
84ac729
Fix Awesome Project links and text
benjaoming Apr 4, 2023
95f98e0
Update caption text for js client screenshot
benjaoming Apr 4, 2023
25d48d5
Clarify rtd js client text
benjaoming Apr 4, 2023
0209d9a
mention screenshot otherwise it's drifting too much
benjaoming Apr 4, 2023
8dcc62d
Apply suggestions from @humitos code review
benjaoming Apr 5, 2023
af9f4cc
Update newsletter-april-2023.rst
benjaoming Apr 5, 2023
a9f9a07
Merge everything about the new JS client in one update with several p…
benjaoming Apr 5, 2023
2b623d9
Bump date and improve language
benjaoming Apr 7, 2023
f6f5885
Merge branch 'main' into newsletter-april-2023
benjaoming Apr 7, 2023
2fd0921
use READTHEDOCS_CANONICAL_URL
benjaoming Apr 7, 2023
e5cf44c
Merge branch 'newsletter-april-2023' of github.com:readthedocs/blog i…
benjaoming Apr 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update newsletter-april-2023.rst
  • Loading branch information
@benjaoming
benjaoming committed Apr 5, 2023
commit af9f4ccd308261b2103069d7ec8a2f9c034f13f4
4 changes: 2 additions & 2 deletions newsletter-april-2023.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 16,8 @@ News and updates
----------------

- 📚️ Over the past 6 months, we gradually refactored our user documentation to align with the `Diátaxis Framework <https://diataxis.fr>`__. The results have now crystialized in the structure of the navigation sidebar and the landing page on `docs.readthedocs.io <https://docs.readthedocs.io/en/stable/>`__.
- 🌄️ The first proof-of-concept for a new API and JavaScript library has been test-driven. It is capable of displaying a menu matching our current :doc:`flyout menu <readthedocs:flyout-menu>` visible in the below screenshot.
The big difference will be that the new API and library will be useful for any documentation framework or static site generator to allow for full control of the new flyout menu and access to API data.
- 🌄️ The first proof-of-concept for a new API and JavaScript library has been test-driven. It is capable of displaying a menu matching our current :doc:`flyout menu <readthedocs:flyout-menu>` and :doc:`integrated server side search <readthedocs:/server-side-search/index>`.
The new library is useful for *any* documentation framework or static site generator to allow for full control of the new flyout menu, integrated search and general access to API data. See the screenshot further down where the integrated search in action on the documentation framework Docusaurus.
- 📊️ All of our websites now use `Plausible <https://plausible.io/>`__ for analytics.
benjaoming marked this conversation as resolved.
Show resolved Hide resolved
- ⚙️ Added a new build variable ``READTHEDOCS_CANONICAL_URL`` that's useful for projects that want to be aware of the canonical base URL while building.
`View docs <https://docs.readthedocs.io/en/stable/reference/environment-variables.html#envvar-READTHEDOCS_CANONICAL_URL>`__.
Expand Down