Migrate content to codebase and change Sphinx theme to Furo #61

activus-d · 2025-03-04T23:46:36Z

No description provided.

codecov · 2025-03-04T23:48:19Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.0%. Comparing base (3ad1e62) to head (d37ccd6).
Report is 10 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #61   +/-   ##
=======================================
  Coverage   100.0%   100.0%           
=======================================
  Files          13       13           
  Lines         720      720           
  Branches       59       59           
=======================================
  Hits          720      720

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

… Furo [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci add sphinx_design and sphinx_copybutton to pyproject.toml and update development.md to indicate sphinx theme change improve grammar and consistency in format of style guide improve table

Stormheg

Thanks Damilola - documentation is turning out nicely.

Made a first pass.

Stormheg · 2025-03-08T20:44:10Z

docs/contributing/index.rst

+Contributing
+============
+
+This package is open source and is licensed under the BSD-3 Clause `License <https://github.com/Stormbase/django-otp-webauthn/blob/main/LICENSE>`_. We welcome all contributions, including code improvements, bug fixes, and documentation updates.


Suggestion (non-blocking): how about we open the scope up a bit?

Suggested change

This package is open source and is licensed under the BSD-3 Clause `License <https://github.com/Stormbase/django-otp-webauthn/blob/main/LICENSE>`_. We welcome all contributions, including code improvements, bug fixes, and documentation updates.

This package is open source and is licensed under the BSD-3 Clause `License <https://github.com/Stormbase/django-otp-webauthn/blob/main/LICENSE>`_. We welcome all contributions, including translations, bug reports, tutorials, code improvements, and documentation updates.

Stormheg · 2025-03-08T20:45:26Z

docs/contributing/index.rst

+
+5. Submit a pull request using your newly created branch.
+
+6. Ensure your pull request has a clear and detailed description of the changes and include a link to the previously opened issue.


Follow-up (non-blocking): how about we set up issue report templates?

Check out this issue template that I created for the Canonical Ubuntu Server docs repository. Let me know if you like it. You can also suggest ways you think we can improve it.

Stormheg · 2025-03-08T20:47:08Z

docs/contributing/index.rst

+    .. code-block:: console
+
+        caddy trust
+


Suggestion: What about running the tests? Creating new translations?

@Stormheg I can't find the instructions on creating new translations in the README.md and DEVELOPMENT.md files

Stormheg · 2025-03-08T20:50:35Z

docs/contributing/style_guide.rst

+Words to avoid
+--------------
+
+Avoid informal or unclear words. Use the following table for guidance:


Suggestion: how about we explicitly list (internet) slang as something to avoid and add some examples?

ymmv -> you may not see the same results

u need to download Python -> you need to download Python

Stormheg · 2025-03-08T20:56:55Z

docs/contributing/style_guide.rst

+----------------+---------------------------------------------------------+
+| does not yet   | doesn’t                                                 |
+----------------+---------------------------------------------------------+
+| e.g.           | for example or such as                                  |


Suggestion: we should make clear why we avoid latin acronyms? Link to the relevant page in the Google Styleguide?

Stormheg · 2025-03-08T21:33:14Z

docs/glossary.rst

+    WebAuthn credential
+        A term defined in the Web Authentication specification. It's a key-based credential generated during a WebAuthn registration process, consisting of a public-private :term:`key pair`. The private key is securely stored on the user's device, while the public key is stored on the server for verifying future authentications.
+
+        This should not be confused with the WebAuthnCredential model, which only stores the public key and associated metadata.


Good opportunity for a link to the WebAuthnCredential reference page?

Are you suggesting that we create a reference page for WebAuthnCredential?
Currently, we have 4 pages in the Reference section:

Views

Helper

Models

JSON request and response

Stormheg · 2025-03-08T21:33:46Z

docs/index.rst


-      {% load otp_webauthn %}
+* **Batteries:** Comes with a default frontend JavaScript implementation that works out of the box.


Suggested change

* **Batteries:** Comes with a default frontend JavaScript implementation that works out of the box.

* **Frontend included:** Comes with a default frontend JavaScript implementation that works out of the box.

Decided I don't want to claim 'batteries included' anymore, figurative speech

Stormheg · 2025-03-08T21:34:58Z

docs/index.rst

-              <div id="passkey-register-status-message"></div>
-          </div>
-      </template>
+* **Flexible frontend:** Users can customize the default UI to match their brand or implement a fully custom frontend.


Suggested change

* **Flexible frontend:** Users can customize the default UI to match their brand or implement a fully custom frontend.

* **Flexible frontend:** Developers can style the provided user interface to match their brand or implement a fully custom frontend using the provided api views

Stormheg · 2025-03-08T21:38:25Z

docs/limitations.rst

+Limitations
+===========


Issue: I don't like the term 'limitations', why not frequently answered questions?

Perhaps we should suggest a different title that sounds more positive. FAQs often feel like a sign of missing documentation or uncertainty, which doesn’t reflect well on the project and the documentation.

Stormheg · 2025-03-08T21:39:17Z

docs/conf.py

-    "github_type": "star",
-    "github_user": "Stormbase",
-    "github_repo": "django-otp-webauthn",
+    "source_repository": "https://github.com/Stormbase/django-otp-webauthn",


Feel free to update the copyright as well

Stormheg · 2025-03-08T21:49:43Z

@activus-d I presume it is not possible to bring the GitHub stargazer count back?

activus-d · 2025-03-13T09:21:54Z

GitHub stargazer count

The GitHub stargazer count isn’t a built-in feature of the Furo Sphinx theme. If we want to bring it back, we have to implement a custom solution.

activus-d requested a review from Stormheg March 5, 2025 00:00

activus-d force-pushed the add-content branch from 72e503d to d37ccd6 Compare March 6, 2025 04:26

Stormheg reviewed Mar 8, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate content to codebase and change Sphinx theme to Furo #61

Migrate content to codebase and change Sphinx theme to Furo #61

activus-d commented Mar 4, 2025

codecov bot commented Mar 4, 2025 •

edited

Loading

Stormheg left a comment

Stormheg Mar 8, 2025

Stormheg Mar 8, 2025

activus-d Mar 12, 2025 •

edited

Loading

Stormheg Mar 8, 2025

activus-d Mar 12, 2025

Stormheg Mar 8, 2025

Stormheg Mar 8, 2025

Stormheg Mar 8, 2025

activus-d Mar 13, 2025

Stormheg Mar 8, 2025

Stormheg Mar 8, 2025

Stormheg Mar 8, 2025

Stormheg Mar 8, 2025

activus-d Mar 12, 2025 •

edited

Loading

Stormheg Mar 8, 2025

Stormheg commented Mar 8, 2025

activus-d commented Mar 13, 2025

	This package is open source and is licensed under the BSD-3 Clause `License <https://github.com/Stormbase/django-otp-webauthn/blob/main/LICENSE>`_. We welcome all contributions, including code improvements, bug fixes, and documentation updates.
	This package is open source and is licensed under the BSD-3 Clause `License <https://github.com/Stormbase/django-otp-webauthn/blob/main/LICENSE>`_. We welcome all contributions, including translations, bug reports, tutorials, code improvements, and documentation updates.


		5. Submit a pull request using your newly created branch.

		6. Ensure your pull request has a clear and detailed description of the changes and include a link to the previously opened issue.


		{% load otp_webauthn %}
		* Batteries: Comes with a default frontend JavaScript implementation that works out of the box.

	* Batteries: Comes with a default frontend JavaScript implementation that works out of the box.
	* Frontend included: Comes with a default frontend JavaScript implementation that works out of the box.

	* Flexible frontend: Users can customize the default UI to match their brand or implement a fully custom frontend.
	* Flexible frontend: Developers can style the provided user interface to match their brand or implement a fully custom frontend using the provided api views

		Limitations
		===========

Migrate content to codebase and change Sphinx theme to Furo #61

Are you sure you want to change the base?

Migrate content to codebase and change Sphinx theme to Furo #61

Conversation

activus-d commented Mar 4, 2025

codecov bot commented Mar 4, 2025 • edited Loading

Codecov Report

Stormheg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

activus-d Mar 12, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

activus-d Mar 12, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Stormheg commented Mar 8, 2025

activus-d commented Mar 13, 2025

codecov bot commented Mar 4, 2025 •

edited

Loading

activus-d Mar 12, 2025 •

edited

Loading

activus-d Mar 12, 2025 •

edited

Loading