Skip to content

Commit

Permalink
Merge pull request #2931 from CosmosOS/zarlo/docs/1
Browse files Browse the repository at this point in the history
more work on docs with ui fixes
  • Loading branch information
quajak authored Jan 28, 2024
2 parents e85a69c + 7eb9e97 commit 3bf9c0d
Show file tree
Hide file tree
Showing 19 changed files with 127 additions and 61 deletions.
5 changes: 5 additions & 0 deletions Docs/api/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
###############
# temp file #
###############
*.yml
.manifest
Empty file added Docs/api/cosmos/index.md
Empty file.
Empty file added Docs/api/il2cpu/index copy.md
Empty file.
Empty file added Docs/api/il2cpu/index.md
Empty file.
Empty file added Docs/api/index.md
Empty file.
Empty file added Docs/api/plugs/index.md
Empty file.
Empty file added Docs/api/xsharp/index.md
Empty file.
2 changes: 1 addition & 1 deletion Docs/articles/toc.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# [Compiler](Compiler/il2cpu.md)

# [Change Log](ChangeLog.md)
# [Change Log](Changelog.md)

# Debugger
## [Debug Commands](Debugger/DebugCommands.md)
Expand Down
33 changes: 25 additions & 8 deletions Docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,33 @@
"src": [
{
"files": [
"Build.sln"
"IL2CPU/source/IL2CPU/IL2CPU.csproj",
"IL2CPU/source/IL2CPU.API/IL2CPU.API.csproj",
"IL2CPU/source/Cosmos.IL2CPU/Cosmos.IL2CPU.csproj"
],
"exclude": [
"**/bin/**",
"**/obj/**"
],
"src": "../"
"src": "../../"
}
],
"dest": "api/il2cpu"
},
{
"src": [
{
"files": [
"XSharp/source/XSharp/XSharp/XSharp.csproj"
],
"exclude": [
"**/bin/**",
"**/obj/**"
],
"src": "../../"
}
],
"dest": "obj/api"
"dest": "api/xsharp"
},
{
"src": [
Expand All @@ -32,7 +49,7 @@
"src": "../"
}
],
"dest": "obj/api/cosmos"
"dest": "api/cosmos"
},
{
"src": [
Expand All @@ -49,7 +66,7 @@
"src": "../"
}
],
"dest": "obj/api/plugs"
"dest": "api/plugs"
}
],
"build": {
Expand All @@ -58,21 +75,21 @@
"files": [
"**/*.yml"
],
"src": "obj/api",
"src": "api",
"dest": "api"
},
{
"files": [
"**/*.yml"
],
"src": "obj/api/cosmos",
"src": "api/cosmos",
"dest": "api/cosmos"
},
{
"files": [
"**/*.yml"
],
"src": "obj/api/plugs",
"src": "api/plugs",
"dest": "api/plugs"
},
{
Expand Down
2 changes: 1 addition & 1 deletion Docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,6 @@ cd ..
3. Wait for the install to progress. (**Tip:** At the end the installer may look like it is stalling, it is still doing something, just in the background)
4. VS will open with Cosmos loaded. You can now make changes to core assemblies of Cosmos. If you don't want to, you can close this VS window and create a new Cosmos project as with the user kit.

For more information about Dev Kit, see [here](https://cosmosos.github.io/articles/Installation/DevKit.html)
For more information about Dev Kit, see [here](articles/Installation/DevKit.html)

Happy Cosmos-ing!
14 changes: 6 additions & 8 deletions Docs/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@
- name: Articles
href: articles/
homepage: articles/GettingStarted.md
- name: API Documentation
items:
- name: Cosmos
href: obj/api/cosmos
- name: X#
href: obj/api/xsharp
- name: IL2CPU
href: obj/api/il2cpu
- name: Cosmos
href: api/cosmos/
- name: X#
href: api/xsharp/
- name: IL2CPU
href: api/il2cpu/
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@
"requested": "[4.7.0, )",
"resolved": "4.7.0",
"contentHash": "pTj+D3uJWyN3My70i2Hqo+OXixq3Os2D1nJ2x92FFo6sk8fYS1m1WLNTs0Dc1uPaViH0YvEEwvzddQ7y4rhXmA=="
},
"Microsoft.NETFramework.ReferenceAssemblies": {
"type": "Direct",
"requested": "[1.0.3, )",
"resolved": "1.0.3",
"contentHash": "vUc9Npcs14QsyOD01tnv/m8sQUnGTGOw1BCmKcv77LBJY7OxhJ+zJF7UD/sCL3lYNFuqmQEVlkfS4Quif6FyYg==",
"dependencies": {
"Microsoft.NETFramework.ReferenceAssemblies.net48": "1.0.3"
}
},
"Microsoft.NETFramework.ReferenceAssemblies.net48": {
"type": "Transitive",
"resolved": "1.0.3",
"contentHash": "zMk4D+9zyiEWByyQ7oPImPN/Jhpj166Ky0Nlla4eXlNL8hI/BtSJsgR8Inldd4NNpIAH3oh8yym0W2DrhXdSLQ=="
}
}
}
Expand Down
24 changes: 19 additions & 5 deletions source/Cosmos.Build.Tasks/packages.lock.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@
"System.Collections.Immutable": "5.0.0"
}
},
"Microsoft.NETFramework.ReferenceAssemblies": {
"type": "Direct",
"requested": "[1.0.3, )",
"resolved": "1.0.3",
"contentHash": "vUc9Npcs14QsyOD01tnv/m8sQUnGTGOw1BCmKcv77LBJY7OxhJ+zJF7UD/sCL3lYNFuqmQEVlkfS4Quif6FyYg==",
"dependencies": {
"Microsoft.NETFramework.ReferenceAssemblies.net48": "1.0.3"
}
},
"Dapper.StrongName": {
"type": "Transitive",
"resolved": "2.0.90",
Expand All @@ -42,6 +51,11 @@
"resolved": "1.3.0",
"contentHash": "/fn1Tfo7j7k/slViPlM8azJuxQmri7FZ8dQ+gTeLbI29leN/1VK0U/BFcRdJNctsRCUgyKJ2q+I0Tjq07Rc1/Q=="
},
"Microsoft.NETFramework.ReferenceAssemblies.net48": {
"type": "Transitive",
"resolved": "1.0.3",
"contentHash": "zMk4D+9zyiEWByyQ7oPImPN/Jhpj166Ky0Nlla4eXlNL8hI/BtSJsgR8Inldd4NNpIAH3oh8yym0W2DrhXdSLQ=="
},
"Microsoft.VisualStudio.Setup.Configuration.Interop": {
"type": "Transitive",
"resolved": "1.16.30",
Expand Down Expand Up @@ -112,8 +126,8 @@
},
"System.Data.SqlClient": {
"type": "Transitive",
"resolved": "4.8.5",
"contentHash": "fRqxut4lrndPHrXD+ht1XRmCL3obuKldm4XjCRYS9p5f7FSR7shBxAwTkDrpFMsHC9BhNgjjmUtiIjvehn5zkg=="
"resolved": "4.8.6",
"contentHash": "2Ij/LCaTQRyAi5lAv7UUTV9R2FobC8xN9mE0fXBZohum/xLl8IZVmE98Rq5ugQHjCgTBRKqpXRb4ORulRdA6Ig=="
},
"System.Diagnostics.Process": {
"type": "Transitive",
Expand Down Expand Up @@ -249,7 +263,7 @@
"SQLitePCLRaw.core": "[2.0.6, )",
"SQLitePCLRaw.lib.e_sqlite3.linux": "[1.1.14, )",
"System.ComponentModel.Annotations": "[5.0.0, )",
"System.Data.SqlClient": "[4.8.5, )",
"System.Data.SqlClient": "[4.8.6, )",
"System.IO.MemoryMappedFiles": "[4.3.0, )",
"System.Reflection.Metadata": "[5.0.0, )"
}
Expand Down Expand Up @@ -277,8 +291,8 @@
},
"System.Data.SqlClient": {
"type": "Transitive",
"resolved": "4.8.5",
"contentHash": "fRqxut4lrndPHrXD+ht1XRmCL3obuKldm4XjCRYS9p5f7FSR7shBxAwTkDrpFMsHC9BhNgjjmUtiIjvehn5zkg=="
"resolved": "4.8.6",
"contentHash": "2Ij/LCaTQRyAi5lAv7UUTV9R2FobC8xN9mE0fXBZohum/xLl8IZVmE98Rq5ugQHjCgTBRKqpXRb4ORulRdA6Ig=="
},
"System.Diagnostics.Process": {
"type": "Transitive",
Expand Down
6 changes: 3 additions & 3 deletions source/Cosmos.Core_Asm/packages.lock.json
Original file line number Diff line number Diff line change
Expand Up @@ -348,8 +348,8 @@
},
"System.Data.SqlClient": {
"type": "Transitive",
"resolved": "4.8.5",
"contentHash": "fRqxut4lrndPHrXD+ht1XRmCL3obuKldm4XjCRYS9p5f7FSR7shBxAwTkDrpFMsHC9BhNgjjmUtiIjvehn5zkg==",
"resolved": "4.8.6",
"contentHash": "2Ij/LCaTQRyAi5lAv7UUTV9R2FobC8xN9mE0fXBZohum/xLl8IZVmE98Rq5ugQHjCgTBRKqpXRb4ORulRdA6Ig==",
"dependencies": {
"Microsoft.Win32.Registry": "4.7.0",
"System.Security.Principal.Windows": "4.7.0",
Expand Down Expand Up @@ -1139,7 +1139,7 @@
"SQLitePCLRaw.core": "[2.0.6, )",
"SQLitePCLRaw.lib.e_sqlite3.linux": "[1.1.14, )",
"System.ComponentModel.Annotations": "[5.0.0, )",
"System.Data.SqlClient": "[4.8.5, )",
"System.Data.SqlClient": "[4.8.6, )",
"System.IO.MemoryMappedFiles": "[4.3.0, )",
"System.Reflection.Metadata": "[5.0.0, )"
}
Expand Down
6 changes: 3 additions & 3 deletions source/Cosmos.Core_Plugs/packages.lock.json
Original file line number Diff line number Diff line change
Expand Up @@ -348,8 +348,8 @@
},
"System.Data.SqlClient": {
"type": "Transitive",
"resolved": "4.8.5",
"contentHash": "fRqxut4lrndPHrXD+ht1XRmCL3obuKldm4XjCRYS9p5f7FSR7shBxAwTkDrpFMsHC9BhNgjjmUtiIjvehn5zkg==",
"resolved": "4.8.6",
"contentHash": "2Ij/LCaTQRyAi5lAv7UUTV9R2FobC8xN9mE0fXBZohum/xLl8IZVmE98Rq5ugQHjCgTBRKqpXRb4ORulRdA6Ig==",
"dependencies": {
"Microsoft.Win32.Registry": "4.7.0",
"System.Security.Principal.Windows": "4.7.0",
Expand Down Expand Up @@ -1160,7 +1160,7 @@
"SQLitePCLRaw.core": "[2.0.6, )",
"SQLitePCLRaw.lib.e_sqlite3.linux": "[1.1.14, )",
"System.ComponentModel.Annotations": "[5.0.0, )",
"System.Data.SqlClient": "[4.8.5, )",
"System.Data.SqlClient": "[4.8.6, )",
"System.IO.MemoryMappedFiles": "[4.3.0, )",
"System.Reflection.Metadata": "[5.0.0, )"
}
Expand Down
38 changes: 14 additions & 24 deletions source/Cosmos.Debug.GDB/packages.lock.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@
"version": 1,
"dependencies": {
".NETFramework,Version=v4.7.2": {
"Microsoft.NETFramework.ReferenceAssemblies": {
"type": "Direct",
"requested": "[1.0.3, )",
"resolved": "1.0.3",
"contentHash": "vUc9Npcs14QsyOD01tnv/m8sQUnGTGOw1BCmKcv77LBJY7OxhJ+zJF7UD/sCL3lYNFuqmQEVlkfS4Quif6FyYg==",
"dependencies": {
"Microsoft.NETFramework.ReferenceAssemblies.net472": "1.0.3"
}
},
"Microsoft.NETFramework.ReferenceAssemblies.net472": {
"type": "Transitive",
"resolved": "1.0.3",
"contentHash": "0E7evZXHXaDYYiLRfpyXvCh+yzM2rNTyuZDI+ZO7UUqSc6GfjePiXTdqJGtgIKUwdI81tzQKmaWprnUiPj9hAw=="
},
"Microsoft.Win32.Registry": {
"type": "Transitive",
"resolved": "5.0.0",
Expand Down Expand Up @@ -30,30 +44,6 @@
"Microsoft.Win32.Registry": "[5.0.0, )"
}
}
},
".NETFramework,Version=v4.7.2/win7-x86": {
"Microsoft.Win32.Registry": {
"type": "Transitive",
"resolved": "5.0.0",
"contentHash": "dDoKi0PnDz31yAyETfRntsLArTlVAVzUzCIvvEDsDsucrl33Dl8pIJG06ePTJTI3tGpeyHS9Cq7Foc/s4EeKcg==",
"dependencies": {
"System.Security.AccessControl": "5.0.0",
"System.Security.Principal.Windows": "5.0.0"
}
},
"System.Security.AccessControl": {
"type": "Transitive",
"resolved": "5.0.0",
"contentHash": "dagJ1mHZO3Ani8GH0PHpPEe/oYO+rVdbQjvjJkBRNQkX4t0r1iaeGn8+/ybkSLEan3/slM0t59SVdHzuHf2jmw==",
"dependencies": {
"System.Security.Principal.Windows": "5.0.0"
}
},
"System.Security.Principal.Windows": {
"type": "Transitive",
"resolved": "5.0.0",
"contentHash": "t0MGLukB5WAVU9bO3MGzvlGnyJPgUlcwerXn1kzBRjwLKixT96XV0Uza41W49gVd8zEMFu9vQEFlv0IOrytICA=="
}
}
}
}
6 changes: 3 additions & 3 deletions source/Cosmos.Plugs/packages.lock.json
Original file line number Diff line number Diff line change
Expand Up @@ -347,8 +347,8 @@
},
"System.Data.SqlClient": {
"type": "Transitive",
"resolved": "4.8.5",
"contentHash": "fRqxut4lrndPHrXD+ht1XRmCL3obuKldm4XjCRYS9p5f7FSR7shBxAwTkDrpFMsHC9BhNgjjmUtiIjvehn5zkg==",
"resolved": "4.8.6",
"contentHash": "2Ij/LCaTQRyAi5lAv7UUTV9R2FobC8xN9mE0fXBZohum/xLl8IZVmE98Rq5ugQHjCgTBRKqpXRb4ORulRdA6Ig==",
"dependencies": {
"Microsoft.Win32.Registry": "4.7.0",
"System.Security.Principal.Windows": "4.7.0",
Expand Down Expand Up @@ -1206,7 +1206,7 @@
"SQLitePCLRaw.core": "[2.0.6, )",
"SQLitePCLRaw.lib.e_sqlite3.linux": "[1.1.14, )",
"System.ComponentModel.Annotations": "[5.0.0, )",
"System.Data.SqlClient": "[4.8.5, )",
"System.Data.SqlClient": "[4.8.6, )",
"System.IO.MemoryMappedFiles": "[4.3.0, )",
"System.Reflection.Metadata": "[5.0.0, )"
}
Expand Down
24 changes: 19 additions & 5 deletions source/Cosmos.VS.DebugEngine/packages.lock.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
"version": 1,
"dependencies": {
".NETFramework,Version=v4.8": {
"Microsoft.NETFramework.ReferenceAssemblies": {
"type": "Direct",
"requested": "[1.0.3, )",
"resolved": "1.0.3",
"contentHash": "vUc9Npcs14QsyOD01tnv/m8sQUnGTGOw1BCmKcv77LBJY7OxhJ+zJF7UD/sCL3lYNFuqmQEVlkfS4Quif6FyYg==",
"dependencies": {
"Microsoft.NETFramework.ReferenceAssemblies.net48": "1.0.3"
}
},
"Microsoft.VisualStudio.Debugger.Engine": {
"type": "Direct",
"requested": "[17.0.2012801, )",
Expand Down Expand Up @@ -234,6 +243,11 @@
"resolved": "1.1.3",
"contentHash": "3Wrmi0kJDzClwAC+iBdUBpEKmEle8FQNsCs77fkiOIw/9oYA07bL1EZNX0kQ2OMN3xpwvl0vAtOCYY3ndDNlhQ=="
},
"Microsoft.NETFramework.ReferenceAssemblies.net48": {
"type": "Transitive",
"resolved": "1.0.3",
"contentHash": "zMk4D+9zyiEWByyQ7oPImPN/Jhpj166Ky0Nlla4eXlNL8hI/BtSJsgR8Inldd4NNpIAH3oh8yym0W2DrhXdSLQ=="
},
"Microsoft.ServiceHub.Analyzers": {
"type": "Transitive",
"resolved": "3.0.3078",
Expand Down Expand Up @@ -961,8 +975,8 @@
},
"System.Data.SqlClient": {
"type": "Transitive",
"resolved": "4.8.5",
"contentHash": "fRqxut4lrndPHrXD+ht1XRmCL3obuKldm4XjCRYS9p5f7FSR7shBxAwTkDrpFMsHC9BhNgjjmUtiIjvehn5zkg=="
"resolved": "4.8.6",
"contentHash": "2Ij/LCaTQRyAi5lAv7UUTV9R2FobC8xN9mE0fXBZohum/xLl8IZVmE98Rq5ugQHjCgTBRKqpXRb4ORulRdA6Ig=="
},
"System.Diagnostics.DiagnosticSource": {
"type": "Transitive",
Expand Down Expand Up @@ -1324,7 +1338,7 @@
"SQLitePCLRaw.core": "[2.0.6, )",
"SQLitePCLRaw.lib.e_sqlite3.linux": "[1.1.14, )",
"System.ComponentModel.Annotations": "[5.0.0, )",
"System.Data.SqlClient": "[4.8.5, )",
"System.Data.SqlClient": "[4.8.6, )",
"System.IO.MemoryMappedFiles": "[4.3.0, )",
"System.Reflection.Metadata": "[5.0.0, )"
}
Expand Down Expand Up @@ -1390,8 +1404,8 @@
},
"System.Data.SqlClient": {
"type": "Transitive",
"resolved": "4.8.5",
"contentHash": "fRqxut4lrndPHrXD+ht1XRmCL3obuKldm4XjCRYS9p5f7FSR7shBxAwTkDrpFMsHC9BhNgjjmUtiIjvehn5zkg=="
"resolved": "4.8.6",
"contentHash": "2Ij/LCaTQRyAi5lAv7UUTV9R2FobC8xN9mE0fXBZohum/xLl8IZVmE98Rq5ugQHjCgTBRKqpXRb4ORulRdA6Ig=="
},
"System.Diagnostics.Process": {
"type": "Transitive",
Expand Down
Loading

0 comments on commit 3bf9c0d

Please sign in to comment.