Skip to content

Commit 72d940e

Browse files
committed
Update documentation hyperlinks
1 parent aed943e commit 72d940e

File tree

6 files changed

+31
-20
lines changed

6 files changed

+31
-20
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
The steps to contribute a change are:
44

5-
1. Fork the IronPython3 repository. For more information see [Getting the Sources](docs/getting-the-sources.md).
6-
2. Build the repository. For more information see [Building](docs/building.md).
7-
1. Make your changes on your machine, ensure ```make.ps1 test-all``` runs successfully, and commit your changes. For more information see [Modifying the Sources](docs/modifying-the-sources.md).
8-
1. Push the commits to your fork. This way your name will be the author of the commit in the main IronPython3 tree (once the commits are pulled into the main tree).
9-
1. Create a pull request on Github, this will initiate a code review and CLA signing request
10-
1. The IronPython team will review, and possibly request changes, to your PR
11-
1. Once all comments/questions/concerns have been addressed, your PR will be merged.
5+
1. Fork the IronPython3 repository. For more information see [Getting the Sources](https://github.com/IronLanguages/ironpython3/wiki/Getting-the-sources).
6+
2. Build the repository. For more information see [Building](https://github.com/IronLanguages/ironpython3/wiki/Building).
7+
3. Make your changes on your machine, ensure ```make.ps1 test-all``` runs successfully, and commit your changes. For more information see [Modifying the Sources](https://github.com/IronLanguages/ironpython3/wiki/Modifying-the-sources).
8+
4. Push the commits to your fork. This way your name will be the author of the commit in the main IronPython3 tree (once the commits are pulled into the main tree).
9+
5. Create a pull request on Github, this will initiate a code review and CLA signing request
10+
6. The IronPython team will review, and possibly request changes, to your PR
11+
7. Once all comments/questions/concerns have been addressed, your PR will be merged.
1212

1313
Also, [Collaborative Github Workflow](http://www.eqqon.com/index.php/Collaborative_Github_Workflow) has a very good description of the workflow and tips and tricks when contributing to a project hosted on GitHub.
1414

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,12 @@ System.Console.WriteLine(greetings("world"));
5151
This example assumes that `IronPython` has been added to the C# project as a NuGet package.
5252

5353
## Code of Conduct
54+
5455
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
5556
For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
5657

5758
## State of the Project
59+
5860
The current target is Python 3.4, although features and behaviors from later versions may be included.
5961

6062
See the following lists for features from each version of CPython that have been implemented:
@@ -68,22 +70,29 @@ See the following lists for features from each version of CPython that have been
6870
- [What's New In Python 3.6](WhatsNewInPython36.md)
6971

7072
## Contributing
73+
7174
For details on contributing see the [Contributing](CONTRIBUTING.md) article.
7275

7376
## Upgrading from IronPython 2
74-
For details on upgrading from IronPython 2 to 3 see the [Upgrading from IronPython 2 to 3](docs/upgrading-from-ipy2.md) article.
77+
78+
For details on upgrading from IronPython 2 to 3 see the [Upgrading from IronPython 2 to 3](https://github.com/IronLanguages/ironpython3/wiki/Upgrading-from-IronPython2) article.
7579

7680
## Differences with CPython
77-
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](docs/differences-from-c-python.md) for details.
81+
82+
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/wiki/Differences-from-CPython) for details.
7883

7984
## Package compatibility
80-
See the [Package compatibility](docs/package-compatibility.md) document for information on compatibility with popular packages.
85+
86+
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/wiki/Package-compatibility) document for information on compatibility with popular packages.
8187

8288
## Installation
83-
Binaries of IronPython 3 can be downloaded from the [release page](https://github.com/IronLanguages/ironpython3/releases/latest), available in various formats: `.msi`, `.zip`, `.deb`, `.pkg`. The IronPython package is also available on [NuGet](https://www.nuget.org/packages/IronPython/3.4.0). See the [installation document](docs/installing.md) for detailed instructions on how to install a standalone IronPython interpreter on various operating systems and .NET frameworks.
89+
90+
Binaries of IronPython 3 can be downloaded from the [release page](https://github.com/IronLanguages/ironpython3/releases/latest), available in various formats: `.msi`, `.zip`, `.deb`, `.pkg`. The IronPython package is also available on [NuGet](https://www.nuget.org/packages/IronPython/3.4.0). See the [installation document](https://github.com/IronLanguages/ironpython3/wiki/Installing) for detailed instructions on how to install a standalone IronPython interpreter on various operating systems and .NET frameworks.
8491

8592
## Build
86-
See the [building document](docs/building.md). Since the main development is on Windows, bugs on other platforms may inadvertently be introduced - please report them!
93+
94+
See the [building document](https://github.com/IronLanguages/ironpython3/wiki/Building). Since the main development is on Windows, bugs on other platforms may inadvertently be introduced - please report them!
8795

8896
## Supported Platforms
97+
8998
IronPython 3 targets .NET Framework 4.6.2, .NET Standard 2.0, .NET 6.0 and .NET 8.0. The support for .NET and .NET Core follow the lifecycle defined on [.NET and .NET Core Support Policy](https://dotnet.microsoft.com/platform/support/policy/dotnet-core).

eng/package/choco/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ The current target is Python 3.4, although features and behaviors from later ver
99

1010

1111
## Differences with CPython
12-
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/blob/main/docs/differences-from-c-python.md) for details.
12+
13+
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/wiki/Differences-from-CPython) for details.
1314

1415
## Package compatibility
15-
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/blob/main/docs/package-compatibility.md) document for information on compatibility with popular Python packages.
16+
17+
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/wiki/Package-compatibility) document for information on compatibility with popular Python packages.

eng/package/dotnettool/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ The current target is Python 3.4, although features and behaviors from later ver
99

1010
## Differences with CPython
1111

12-
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/blob/main/docs/differences-from-c-python.md) for details.
12+
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/wiki/Differences-from-CPython) for details.
1313

1414
## Package compatibility
1515

16-
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/blob/main/docs/package-compatibility.md) document for information on compatibility with popular Python packages.
16+
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/wiki/Package-compatibility) document for information on compatibility with popular Python packages.

eng/package/nuget/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ System.Console.WriteLine(greetings("world"));
2222

2323
## Differences with CPython
2424

25-
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/blob/main/docs/differences-from-c-python.md) for details.
25+
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/wiki/Differences-from-CPython) for details.
2626

2727
## Package compatibility
2828

29-
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/blob/main/docs/package-compatibility.md) document for information on compatibility with popular Python packages. Note that to run most packages, IronPython Standard Library must be present.
29+
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/wiki/Package-compatibility) document for information on compatibility with popular Python packages. Note that to run most packages, IronPython Standard Library must be present.

eng/package/zip/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ System.Console.WriteLine(greetings("world"));
5050

5151
## Differences with CPython
5252

53-
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/blob/main/docs/differences-from-c-python.md) for details.
53+
While compatibility with CPython is one of our main goals with IronPython 3, there are still some differences that may cause issues. See [Differences from CPython](https://github.com/IronLanguages/ironpython3/wiki/Differences-from-CPython) for details.
5454

5555
## Package compatibility
5656

57-
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/blob/main/docs/package-compatibility.md) document for information on compatibility with popular packages. Note that to run most packages, IronPython Standard Library must be present.
57+
See the [Package compatibility](https://github.com/IronLanguages/ironpython3/wiki/Package-compatibility) document for information on compatibility with popular packages. Note that to run most packages, IronPython Standard Library must be present.

0 commit comments

Comments
 (0)