Skip to content

Commit

Permalink
- Fixes securefederatedai#1047, set to default page of documentation …
Browse files Browse the repository at this point in the history
…in both root file and docs/ level file (securefederatedai#1050)

Signed-off-by: Shailesh Pant <[email protected]>
  • Loading branch information
ishaileshpant authored Sep 18, 2024
1 parent 6918dc7 commit 3881a48
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contributing to OpenFL

We welcome contributions from the community. There are several ways to contribute:
* Improvements in [documentation](https://openfl.readthedocs.io/en/latest/install.html).
* Improvements in [documentation](https://openfl.readthedocs.io/en/latest/).
* Contributing to OpenFL's code-base: via bug-fixes or feature additions.
* Answering questions on our [discussions page](https://github.com/securefederatedai/openfl/discussions).
* Participating in our [roadmap](https://github.com/securefederatedai/openfl/blob/develop/ROADMAP.md) discussions.
Expand Down Expand Up @@ -75,4 +75,4 @@ A **class** or a **function** docstring may contain:
* A one-line description of the class/function.
* Paragraph(s) of detailed information.
* Optional `Examples` section.
* `Args` section for arguments under `__init__()`.
* `Args` section for arguments under `__init__()`.
4 changes: 2 additions & 2 deletions docs/contributing_guidelines/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ We welcome contributions from the community. We believe that anyone can bring so

We accept various contributions from documentation improvement and bug fixing to major features proposals and [roadmap](https://github.com/intel/openfl/blob/develop/ROADMAP.md) suggestions.

Documentation improvement: review our [documentation](https://openfl.readthedocs.io/en/latest/install.html) and let us know if something is not clear or not relevant.
Documentation improvement: review our [documentation](https://openfl.readthedocs.io/en/latest) and let us know if something is not clear or not relevant.
Propose your own formulations or even write new section explaining something that you know how works, but do not see in the documentation.
Propose it through GitHub [issues](https://github.com/intel/openfl/issues/new/choose) or [Discussions](https://github.com/intel/openfl/discussions).

Expand Down Expand Up @@ -99,4 +99,4 @@ Then you just add a line to every git commit message:
Use your real name (sorry, no pseudonyms or anonymous contributions.)

If you set your `user.name` and `user.email` git configs, you can sign your
commit automatically with `git commit -s`.
commit automatically with `git commit -s`.

0 comments on commit 3881a48

Please sign in to comment.